Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (18 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

29 lines (18 loc) · 1.01 KB
Raw

Intro

All contributions are generally welcome as long as they fit in with the concepts and goals of this repository and as long as the CODE_OF_CONDUCT.md is being respected.

Code Rules

All code must adhere to the RULES.md and mostly follows the Google style. Where it diverges, clang-tidy rules are in effect as much as possible.

Run pre-commit

All changes will be verified by the pre-commit rules. In order to check these before committing changes install the tool:

pre-commit install

Once installed the verification can be triggered for all files as follows:

pre-commit run -a

Without the -a only the modified and staged files will be checked.

Coverage policy

coverage_policy.json is the single source of truth for production-code coverage scope, ratings, and enforcement. See docs/coverage.md before changing coverage thresholds or adding a module-specific exception.