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:

Standard code

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

$ ./vendor/bin/php-cs-fixer fix .

Memio drives its development using phpspec.

First bootstrap the code for the Specification:

$ phpspec describe 'Memio\PrettyPrinter\MyNewUseCase'

Next, write the actual code of the Specification:

$ $EDITOR spec/Memio/PrettyPrinter/MyNewUseCase.php

Then bootstrap the code for the corresponding Use Case:

$ phpspec run

Follow that by writing the actual code of the Use Case:

$ $EDITOR src/Memio/PrettyPrinter/MyNewUseCase.php

Finally run the specification:

$ phpspec run

Results should be green!

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/memio/pretty-printer.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.