16 lines
834 B
Markdown
16 lines
834 B
Markdown
|
# Contributing
|
||
|
|
|
||
|
|
First of all, **thank you** for contributing!
|
||
|
|
|
||
|
|
Here are a few rules to follow in order to ease code reviews and merging:
|
||
|
|
|
||
|
|
- follow [PSR-1](http://www.php-fig.org/psr/1/) and [PSR-2](http://www.php-fig.org/psr/2/)
|
||
|
|
- run the test suite
|
||
|
|
- write (or update) unit tests when applicable
|
||
|
|
- write documentation for new features
|
||
|
|
- use [commit messages that make sense](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
|
||
|
|
|
||
|
|
One may ask you to [squash your commits](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) 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.).
|
||
|
|
|
||
|
|
When creating your pull request on GitHub, please write a description which gives the context and/or explains why you are creating it.
|