Skip to content

Latest commit

 

History

History
23 lines (15 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

23 lines (15 loc) · 1.3 KB

How to contribute

You are very welcome to contribute to Prophiler by e.g. submitting fixes or adding new adapters or data collectors to the library.

Workflow

  • Fork the repository on GitHub
  • Create a separate branch for each bugfix, improvement or new feature
  • Send a pull request on GitHub

Coding Guidelines

As the Prophiler library has a high quality rating and high code coverage, please follow these rules, to keep the quality of the project on a high level:

  • Follow the PSR-2 coding standard: PSR-2 Coding Style Guide
  • Add docblocks to all methods, including at least a description, all @param declarations and the @return declaration
  • Add tests for all changed or added classes and/or methods

Current Status

Scrutinizer Code Quality Code Coverage Build Status