How to contribute

Everybody should be able to help. Here's how you can make this project more awesome:

Your work will then be reviewed as soon as possible (suggestions about some changes, improvements or alternatives may be given).

Here's some tips to make you the best contributor ever:

Green tests

Run the tests using the following script:

$ bin/tester.sh

Use PHP CS fixer to make your code compliant with Redaktilo's coding standards:

$ php-cs-fixer fix --config=sf23 .

Redaktilo drives its development using phpspec.

First boostrap the code for the Specification:

$ phpspec describe 'Gnugat\Redaktilo\MyNewClass'

Then write the code for the Specification:

$ $EDITOR spec/Gnugat/Redaktilo/MyNewClass.php

Next, bootstrap the code for the corresponding clas:

$ phpspec run

Follow that by writing the code of the corresponding class:

$ $EDITOR src/Gnugat/Redaktilo/MyNewClass.php

Finally, execute the specifications:

$ phpspec run

They should be green!

Redaktilo has been created to fulfill actual needs. To keep sure of it, use cases are created and are automated: they become part of the test suite.

Have a look at tests/examples, you might add your own.

To keep your fork up-to-date, you should track the upstream (original) one using the following command:

$ git remote add upstream https://github.com/gnugat/redaktilo.git

Then get the upstream changes:

git checkout main
git pull --rebase origin main
git pull --rebase upstream main
git checkout <your-branch>
git rebase main

Finally, publish your changes:

$ git push -f origin <your-branch>

Your pull request will be automatically updated.