CONTRIBUTION GUIDELINES
Contributions are welcome and will be fully credited.
We accept contributions via pull requests on Github. Please review these guidelines before continuing.
Guidelines
- Please follow the PSR-2 Coding Style Guide.
- Ensure that the current tests pass, and if you've added something new, add the tests where relevant.
- Send a coherent commit history, making sure each individual commit in your pull request is meaningful.
- You may need to rebase to avoid merge conflicts.
- If you are changing or adding to the behaviour or public api, you may need to update the docs.
- Please remember that we follow SemVer.
Running Tests
First, install the dependencies using Composer:
$ make install
Then run PHPUnit and the static analyzers:
$ make test
These will also be automatically run by Travis CI and GitHub Actions against pull requests.