Skip to content

Latest commit

 

History

History
38 lines (21 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

38 lines (21 loc) · 1.17 KB

Contributing

If you want to contribute, please be sure to read this file.

Travis

This project is using Travis for automated builds, please refer to .travis.yml to find out what is going on.

Basically, we run coding style checks and tests as part of the build. However, you can also run these checks and tests locally rather than keeping Travis busy doing it. There's not much more pleasing than a passing build, don't you agree?

Coding Style

This projects follows the PSR-2 Coding Style Guide. Be sure to read it!

Before opening a pull request or pushing more commits, you should run coding style checks locally:

$ ./vendor/bin/php-cs-fixer fix --config-file=./.php_cs --dry-run --diff -v

Run tests

We do have a - somewhat - limited test suite, but are hoping for more.

Please run the tests locally to see if they pass:

$ ./vendor/bin/phpunit --configuration phpunit.xml

Contributors

❤️ Thank you very much for your contributions!