Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

37 lines (25 loc) · 1.58 KB
Raw

Contributing

First of all, thank you for taking time to contribute!

Contributions are accepted via Pull Requests on GitHub. Sometimes, our time is very limited and could take a while until we review your pull request, so please be patient while you wait for code review.

We don't mind getting questions, so if you have any, please open a new issue on our tracker.

Pull Requests

Here are a few rules which you should follow, in order to ease code review and merging:

  1. Follow PSR-2 Coding Standard
  • Create feature branches - We don't pull from your (master|develop) branch!
  • One pull request per feature - If you need/want to change more than one thing, please send multiple pull requests.
  • Consider our release cycle - We follow SemVer v2.0.0. Breaking public APIs is not acceptable.
  • (Add|Update) tests when applicable.
  • Document any change in behaviour - Update documentation and/or readme file when applicable.

Sometimes you might be asked to also squash your commits (we don't want commits such as fix 1, fix <n>, now its working, etc). This is done in order to keep a clean and coherent VCS history.

Running tests

$ composer test

To check against PSR-2 coding standard:

$ composer style