Contributing.md

How to contribute

We love pull requests. And following this guidelines will make your pull request easier to merge.

If you want to contribute but don’t know what to do, take a look at these two labels: help wanted and good first issue.

Use GitHub interface for simple documentation changes, otherwise follow the steps below.

Prerequisites

• If it’s your first pull request, watch this amazing course by Kent C. Dodds.
• Install EditorConfig plugin for your code editor to make sure it uses correct settings.
• Fork the repository and clone your fork.
• Install dependencies: composer install.

Don’t forget to add tests and update documentation for your changes.

Other notes

• If you have commit access to repository and want to make big change or not sure about something, make a new branch and open pull request.
• We’re using php-cs-fixer to format code, so don’t worry much about code formatting and just run

$ composer csfix

• Don’t commit generated files, like artifacts or var directory.
• Don’t change version number and change log.

Need help?

If you want to contribute but have any questions, concerns or doubts, feel free to ping maintainers. Ideally create a pull request with WIP (Work in progress) in its title and ask questions in the pull request description.