Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.57 KB
Raw

CONTRIBUTING

We always appreciate contributions, and will accept pull requests as long as they're following the guidelines listed below. In some cases we may make an exception - if you're struggling, drop me an email to the address listed in the composer.json file and we can discuss it further.

Guidelines

  • Please follow the PSR-2 Coding Standard and PHP-FIG Naming Conventions.
  • Ensure that the current tests pass - instructions are below. If you add something new, please add new tests where relevant.
  • Keep a meaningful git history - we're going to be checking over pull requests, and it'd help a lot if we can see at a glance what each commit relates to. If you had to make multiple minor commits while developing, please squash them before submitting.
  • Please rebase where possible.

Running Tests

Assuming you've already installed Composer...

First, install the dependencies:

$ composer install

Then run phpunit:

$ vendor/bin/phpunit

If you use docker, you can also run the test suite against all supported PHP versions:

./vendor/bin/dunit

Once you've made the pull request, the tests will automatically be run again by Travis CI on all supported php versions.