diff --git a/README.md b/README.md index 87c73fd..79b4c12 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ Some implications on that this is a repository for incubation components * Vulnerability Management (Dependabot) is not enabled for this repository. * Limited effort spent on artifacts like Bill-of-Material and Open Source Scanning * Limited effort spent on testing before creating tags and releases +* Semantic meaning of tags is not well defined Incubation components may be promoted to "real components" in a separate repository if there is a strong interest in the component and active maintainers/contributors willing to maintain the component. @@ -26,6 +27,9 @@ Component | Content | Comment/Status For contribution guidelines see [CONTRIBUTING.md](CONTRIBUTING.md) - - - +## Pre-commit set up +This repository is set up to use [pre-commit](https://pre-commit.com/) hooks. +Use `pip install pre-commit` to install pre-commit. +After you clone the project, run `pre-commit install` to install pre-commit into your git hooks. +Pre-commit will now run on every commit. +Every time you clone a project using pre-commit running pre-commit install should always be the first thing you do.