Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
45 lines (29 sloc) 1.46 KB

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 run the coding standard fixer tool.

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!

Running the test suite

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

Run the tests with the ./vendor/bin/phpunit command.

Running the coding standard fixer tool

The library comes with a basic setup of PHP CS Fixer. It can be executed with the ./vendor/bin/php-cs-fixer command

You can’t perform that action at this time.