What are pre-commit hooks? How do we use them and why?

[scottc943]

What is pre-commit?

Pre-commit is a Git hook that triggers when git commit is attempted.

Get started

pip install pre-commit  #this is actually in the requirements.txt so as long as you install packages with it you will have it
Run pre-commit install #this installs everything needed for the hooks within .pre-commit-config.yaml
Run pre-commit run --all-files    #the first time pre-commit is added to the project so all files are checked

Usage

• Commits are not saved until they pass the pre-commit.
• Based on the example configuration, all files must pass pyright then black formatting.
• Errors will provide details about the files and why the process failed. Fix the issues and commit again until they pass.
• Pre-commit prevents pushing to the code base until they pass.

[kzndotsh]

https://githooks.com/
https://pre-commit.com/

[kzndotsh]

https://github.com/pre-commit/pre-commit-hooks