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/test.sh

Note: Tests also provide a living documentation: phpunit --testdox; phpspec run -f pretty.

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

php-cs-fixer fix src; php-cs-fixer fix tests; php-cs-fixer fix spec --fixers=-visibility

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/search-engine.git

Then get the upstream changes:

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

Finally, publish your changes:

git push -f origin <your-branch>

Your pull request will be automatically updated.