We accept contributions via Pull Requests on Github.
Code must follow PSR-1, PSR-2
Coding Standards - The easiest way to apply the conventions is to install
PHP Code Sniffer and run it.
Add tests! - Your patch won't be accepted if it doesn't have tests.
Run PHPUnit to make sure, that all tests pass.
Document any change in behaviour - Make sure the README.md
and any other relevant documentation are kept up-to-date.
Consider our release cycle - We try to follow SemVer v2.0.0.
Randomly breaking public APIs is not an option. Update CHANGES.md accordingly.
One pull request per feature - If you want to do more than one thing, send multiple pull requests.
If you have GNU Make installed, you can use following shortcuts:
run static code analysis with PHP_CodeSniffer
to check code style
fix code style violations with PHP_CodeSniffer
automatically, where possible (ex. PSR-2 code formatting violations)
run tests with PHPUnit
invokes described above install, cs, test tasks sequentially -
project will be assembled, checked with linter and tested with one single command
$ make test
$ composer test