Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

31 lines (24 loc) · 1.79 KB
Raw

Contributing

Pull Requests are welcome. Consider filing an issue first to discuss your needs and plans. All project participation is subject to the Code of Conduct.

Quality Standards

Maintainability Rating Code Coverage

We try to maintain a very high level of code quality, which should always be possible with such a small project. Please keep that in mind when proposing changes. We will maintain 100% test coverage, small methods, and good separation of concerns between areas of the code.

Structure

The component view of this project (provided by Scrutinizer CI) gives a good overview of how it is constructed:

Code Components

Pull Requests

  • Please follow the PSR-2 Coding Standard. The easiest way to apply the conventions is to install PHP Code Sniffer.
  • Write any tests called for by your changes.
  • Update code comments and README documentation as appropriate.
  • Consider release effects. We practice semantic versioning, so breaking changes will require a major version release.
  • Create topic branches.
  • One pull request per feature.

Running Tests

$ composer test

Or (depending on how you have Composer installed)

$ php ./composer.phar test