This change adds the use of the pre-commit tool. This helps the local workflow to make checks before commiting.
Purpose
It should overall lessen the number of commits made with comments "black formatting" and whatnot as it will check for our standards before allowing a commit. It's basically a local git workflow before you make commits since we all forget about black and pyright.
Checklist
[X] This PR adds something new
[X] This PR is a breaking change (e.g. methods or parameters removed/renamed)
[X] This PR is not a code change (e.g. documentation, README, ...)
Additional Context
If this were to be included, devs would need to install the pre-commit package and run pre-commit install within their local repo. After that the tool is added into the .git features and functional.
Add pre-commit tooling
Description
This change adds the use of the pre-commit tool. This helps the local workflow to make checks before commiting.
Purpose
It should overall lessen the number of commits made with comments "black formatting" and whatnot as it will check for our standards before allowing a commit. It's basically a local git workflow before you make commits since we all forget about black and pyright.
Checklist
Additional Context
If this were to be included, devs would need to install the pre-commit package and run
pre-commit install
within their local repo. After that the tool is added into the.git
features and functional.Reviewer Notes