Skip to content

Latest commit

 

History

History
24 lines (16 loc) · 1.03 KB

Contributing.md

File metadata and controls

24 lines (16 loc) · 1.03 KB
Raw

Contributing

First of all, thank you for contributing.

Bugs or feature requests can be posted online on the GitHub issues section of the project.

Few rules to ease code reviews and merges:

  • You MUST follow the PSR-1, PSR-2 and PSR-4.
  • You MUST run the test suite.
  • You MUST write (or update) unit tests when bugs are fixed or features are added.
  • You SHOULD write documentation.

To contribute use Pull Requests, please, write commit messages that make sense, and rebase your branch before submitting your PR

May be asked to squash your commits too. This is used to "clean" your Pull Request before merging it, avoiding commits such as fix tests, fix 2, fix 3, etc.

Run test suite

  • install composer: curl -s http://getcomposer.org/installer | php
  • install dependencies: php composer.phar install --dev
  • run tests: vendor/bin/simple-phpunit