Skip to content

Latest commit

 

History

History
38 lines (33 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

38 lines (33 loc) · 1.81 KB
Raw

Contribution Guidelines

This project is wide open to contributions. You can use GitHub to report issues or submit pull requests. When opening pull requests, it is recommended to follow these guidelines in order to grease the wheels, so to speak.

Please include as many details as you can in any issues and pull requests. Understanding how you are using the library and exactly what problems you are having can also help make things move quickly.

Building

There is an included build script that you can execute locally to run the code through the PSR-1 coding standard and the PHPUnit test suite. Code coverage is kept at 100% according to PHPUnit's code coverage report. This is inforced using coveralls.

Alternatively, you can use Docker and/or Docker Compose to execute the build:

docker-compose run build

Automated builds

Pull requests will automatically have a build kicked off on Travis CI and Scrutinizer CI. The results of these builds are monitored closely for all pull requests.