Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

57 lines (39 loc) · 1.44 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.

Coding standards

You MUST follow the PSR-12. If you don't know about any of them, you should really read the recommendations. Can't wait? Use the symplify/easy-coding-standard:

$ vendor/bin/ecs --fix

In addition, we try to use the baseline code as close as the current PHP version features. For that, we use Rector.

$ vendor/bin/rector process

Note: Never fix coding standards in some existing code as it makes code review more difficult.

Running the test suite

You MUST run the test suite.

  • Setup the project using Composer:

    $ composer install

  • Run the test suite:

    $ composer test

You MUST write (or update) unit tests.

Documentation

You SHOULD write documentation.

Additional notes

Before submitting your Pull Request, please rebase your branch.
When submitting your Pull Request, please choose a title that makes sense, it will be used as message for the merge commit if your change is accepted.

Thank you!