diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4e7f33bd..0a25adc7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -165,6 +165,9 @@ Enhancement suggestions are tracked as There is a [coding style document](CodingStyle.md) next to this guide. +Please install the [pre-commit hooks](.pre-commit-config.yaml) via `pre-commit +install`. + ## Attribution diff --git a/README.md b/README.md index 96d18b37..68404e4a 100644 --- a/README.md +++ b/README.md @@ -108,3 +108,11 @@ Please see the [contributing document](CONTRIBUTING.md). Developers shall use the coding style rules in the [coding style file](CodingStyle.md). + +There is a [cpplint configuration](CPPLINT.cfg) included as well that is +automatically checked via [pre-commit hooks](.pre-commit-config.yaml). So +please install the pre-commit hooks via + +```bash +pre-commit install +```