Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

26 lines (18 loc) · 1.24 KB
Raw

Contributing

First, thank you!

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.
  • 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.).

Also, when creating your Pull Request on GitHub, you MUST write a description which gives the context and/or explains why you are creating it.

PHP CS Fixer

composer install --working-dir=tools/php-cs-fixer
# Check what can be fixed
tools/php-cs-fixer/vendor/bin/php-cs-fixer fix --dry-run --diff
# Fix them
tools/php-cs-fixer/vendor/bin/php-cs-fixer fix --diff