diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e08ca0e5..7ff83c13 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,11 +6,13 @@ This document provides guidelines for contributing to the module. Validate your changes inside the blueprint-agent described in [.Dockerfile](.docker/Dockerfile). It can be run `make dBuildAndRun`. -## Linting and Formatting +## Pre-commits: Linting, Formatting and Secrets Scanning Many of the files in the repository can be linted or formatted to maintain a standard of quality. +Additionally, secret leaks are watched via gitleaks and git-secrets. + When working with the repository for the first time run pre-commit Run `pre-commit install`