Skip to content

Latest commit

 

History

History
executable file
·
39 lines (19 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
39 lines (19 loc) · 1.24 KB
Raw

Contributing

Contributions are welcome and will be fully credited.

Pull Requests

  • Document any change in behaviour - Make sure the README.md and any other relevant documentation are kept up-to-date.

  • Create feature branches - Don't ask us to pull from your master branch.

  • One pull request per feature - If you want to do more than one thing, 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.

Coding Standard

$ composer require zenify/coding-standard --dev  
$ vendor/bin/phpcs src tests --extensions=php --ignore=bootstrap --standard=vendor/zenify/coding-standard/src/ZenifyCodingStandard/ruleset.xml

Tests

  • Add tests! - Your patch won't be accepted if it doesn't have tests.

  • Run tests by calling phpunit (requires having PHPUnit installed locally)

Both coding standard and tests are validated by Travis CI, so just make it pass.

Happy coding!