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 run the test suite.
You MUST run the coding standard fixer tool.
You MUST write (or update) unit tests.
You SHOULD write documentation.
One may ask you to squash your
too. This is used to "clean" your Pull Request before merging it (we don't want
commits such as
fix 3, etc.).
Running the test suite
Ensure that the required vendors are installed by running
Run the tests with the
Running the coding standard fixer tool
The library comes with a basic setup of PHP CS Fixer.
It can be executed with the