Skip to content

Latest commit

 

History

History
44 lines (25 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

44 lines (25 loc) · 1.33 KB
Raw

Contributing

Contributions are welcome and will be fully credited.

We accept contributions via pull requests on GitHub.

Issues

  • Please report issues here on GitHub

Pull Requests

  • Add tests! - Your patch will not be accepted if it does not have tests.

  • Document any change in behaviour - Make sure the documentation in README.md and the CHANGELOG.md is kept up-to-date.

  • Consider our release cycle - We follow SemVer v2.0.0. Randomly breaking public APIs is not an option.

  • Create topic branches - Do not ask us to pull from your master branch.

  • One pull request per feature - If you want to do more than one thing, please send multiple pull requests.

  • Send coherent history - Make 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.

Running tests

$ php vendor/bin/phpunit.phar -c build/

This includes a code coverage report in HTML and Clover XML.

Analyze code

$ php vendor/bin/phpmetrics.phar --report-html=build/logs/phpmetrics src/

Create API documentation

$ php vendor/bin/phpdox.phar -f build/phpdox.xml