Contributing

Contributions to this project are always welcome. If you notice a bug or have an idea for a feature, please feel to send a pull request via Github.

Please make sure to adhere to the following guidelines:

Please adhere to the PSR-2 Coding Standard
Write unit tests for any functionality you are adding
Any new features or changes in behaviour should be explained in the documentation. Don't forget to build the docs.
Send one pull request per feature and send each from their own feature branch. Don't send a pull request from your master branch.

Tests

The test suite can be run using phpunit

$ phpunit

The documentation is written in ReStructuredText, which needs to be built with Sphinx before the changes will appear.

To install Sphinx:

$ pip install Sphinx

To build the docs:

$ cd docs/
$ make html