Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1.42 KB

Contributing

Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests.

Guidelines

  • Please follow the PSR-2 Coding Standard .
  • Ensure that the current tests pass, and if you've added something new, add the tests where relevant. Your patch won't be accepted if it requires tests.
  • Remember that we try to follow SemVer. If you are changing the behaviour, or the public api, you may need to update the docs. Randomly breaking public APIs is not an option.
  • Send one pull request per feature. If you want to do more than one thing, send multiple pull requests.
  • Send a coherent commit history, making sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
  • You may also need to rebase to avoid merge conflicts.

Running Tests

You will need to install Composer before continuing.

First, install the dependencies:

$ composer install

Then run phpunit:

$ vendor/bin/phpunit

If the test suite passes on your local machine you should be good to go.

Happy coding!