Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

30 lines (21 loc) · 1.1 KB

Contributing

If you are reading this, thank you! You are about to make things better and this makes you a hero!

Here are a few rules to follow in order to ease code reviews, and discussions before maintainers accept and merge your work.

You MUST follow the PSR-1 and PSR-2. If you don't know about any of them, you should really read the recommendations. Can't wait? Use the PHP-CS-Fixer tool.

You MUST run the test suite.

You MUST write (or update) unit tests.

You SHOULD write documentation.

Please, write commit messages that make sense, and rebase your branch before submitting your Pull Request.

One may ask you to squash your commits 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.).

Thank you very much!