The contribution is accepted via Pull Requests
-
Follow the conventions used in the project. - Fix the code style with
$ php-cs-fixer fix
. -
Add tests! - Your patch won't be accepted if it doesn't have tests.
-
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.
-
Create feature branches - Don't ask us to pull from your master branch, create branch, e.g.
feature-name
orbugfix-title
. -
One pull request per feature - If you want to do more than one thing, send multiple pull requests. Use appropriate labels.
-
Send coherent 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. Please read How to write a good Git commit messages
$ phpunit
- PSR-1: Basic Coding Standard
- PSR-2: Coding Style Guide
- PSR-4: Autoloading Standard
- PSR-5: PHPDoc (draft)
- Keep the order of class elements: static properties, instance properties, constructor (or setUp for PHPUnit), destructor (or tearDown for PHPUnit), static methods, instance methods, magic static methods, magic instance methods.
Enjoy coding!