Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 1.4 KB
Raw

Contributing

First of all, thank you for contributing, you are awesome!

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!

How to contribute ?

  • Fork the repository
  • Clone it locally
  • Create a new branch
  • Do some work, commit
  • Push your work to your forked repository
  • Back on GitHub, you can now create your pull request !

Running the test suite

Ensure that the required vendors are installed by running composer install.

Run the tests with the make tests command.