diff --git a/templates/python/code_quality/pre-commit/README.md b/templates/python/code_quality/pre-commit/README.md index bad732cd987e0431e872628b2b9a4478de161c27..09363f3df92c232af12b8501239224ac36cf8656 100644 --- a/templates/python/code_quality/pre-commit/README.md +++ b/templates/python/code_quality/pre-commit/README.md @@ -27,3 +27,14 @@ framework for managing and maintaining multi-language pre-commit hooks. To add configuration to `pre-commit`, you can add a `.pre-commit-config.yaml` file to the root of your repository. This file will be used by `pre-commit` to configure the hooks. + +## Example of use + +Here is a configuration example for `pre-commit` for `pre-push` stage: + +```yaml +pre-push: + extends: pre-commit + variables: + PRE_COMMIT_RUN: pre-commit run --all-files --hook-stage pre-push +```