Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

45 lines (30 loc) · 1.77 KB

Contributing

Contributions are welcome. Please report any issue you find in the issues page. Pull requests are more than welcome. Please review these guidelines before submitting any pull requests.

Guidelines

  • Please follow the PSR-12 Coding Standard.
  • Ensure that the current tests pass, and if you've added something new, add the tests where relevant.
  • Remember that we follow SemVer. If you are changing the behaviour, or the public API, you may need to update the README.md and other relevant documentation.
  • 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.
  • Please create feature branches for your pull requests.
  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.
  • You may also need to rebase to avoid merge conflicts.

Running Tests

You will need an installation of Composer before continuing.

First, install the dependencies:

$ composer install

Then run phpunit:

$ composer test

For window users:

$ composer test-win

Ensure to have a good code coverage during your tests:

$ composer test-coverage

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

Happy coding!