Thank you for considering contributing towards this project.
We accept contributions via pull requests on Github.
-
PSR-2 Coding Standard - Check the code style with
$ composer cs-check
and fix it with$ composer cs-fix
. -
Add tests! - Your patch may not be accepted if it doesn't have tests.
-
Document any changes - Make sure the
README.md
and thedocs
are reflected with the update/change. -
Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.
-
Create feature branches - Don't ask us to pull from your master branch.
-
One PR per feature - If you want to do more than one thing, send multiple pull requests.
-
Squash commit history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
$ composer test
This contribution guide has been adapted from the thephpleague's skeleton package.
Happy coding!