Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.41 KB
Raw

CONTRIBUTING

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

Guidelines

  • The git branching model used for development is the one described and assisted by twgit tool: https://github.com/Twenga/twgit.
  • Please follow the PSR-2 Coding Style Guide, enforced by StyleCI.
  • 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 the behavior, or the public api, you may need to update the docs.
  • Please remember that we follow SemVer.

Running Tests

You will need an install of 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.

When you make a pull request, the tests will automatically be run again by Travis CI.

We also have StyleCI setup to automatically fix any code style issues.