First of all, thank you for contributing, you are awesome!
Here are a few rules to follow in order to ease code reviews, and discussions before maintainers accept and merge your work.
You MUST follow the PSR-1 and PSR-2. If you don't know about any of them, you should really read the recommendations. Can't wait? Use the PHP-CS-Fixer tool.
You MUST run the test suite.
You MUST write (or update) unit tests.
You SHOULD write documentation.
Please, write commit messages that make sense, and rebase your branch before submitting your Pull Request.
One may ask you to squash your
commits
too. This is used to "clean" your Pull Request before merging it (we don't want
commits such as fix tests, fix 2, fix 3, etc.).
Thank you!
Ensure that the required vendors are installed by running composer install.
The test suite requires the php5-sqlite extension to be installed.
Run the tests with the make databases && make tests command.
N.B: some of the tests need a running Elasticsearch server. If you don't
have one, you can use the make elasticsearch_start command to start one using
a docker image. Once you don't need it anymore, you can stop it using make elasticsearch_stop.
If you want to use your own Elasticsearch instance, update the host and port to
use by editing the .env file.