diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
@@ -116,3 +116,16 @@ The potential reasons are sorted by probability of being the root cause. | code | potential reason | | :---: | :---| | 17 | login credential mismatch, potential api permission problem | + +### pre-commit framework +This project utilizes the [pre-commit](https://pre-commit.com/) framework to automate various small hick-ups that tend +to happen prior to committing. + +To use the framework it is necessary to follow these steps: +```bash +# install the pre-commit hook +pre-commit install + +# to test your staged files manually run +pre-commit run +``` |