We have been using pre-commit on the Python team for over a year and it has been a great help in development. It is optional for local use, but runs in CI.
I've added a minimal set of integrity checks, including making sure the docs build without warnings. As a follow on, we may wish to enable the end-of-file-fixer, trailing-whitespace, and check-json hooks and then add that commit to a .git-blame-ignore-revs file so it doesn't show up in git blame (GitHub also honors this file).
I've left out the rst-backticks check and codespell for now, but those will also be useful for correctness, for example:
We have been using
pre-commit
on the Python team for over a year and it has been a great help in development. It is optional for local use, but runs in CI.I've added a minimal set of integrity checks, including making sure the docs build without warnings. As a follow on, we may wish to enable the
end-of-file-fixer
,trailing-whitespace
, andcheck-json
hooks and then add that commit to a.git-blame-ignore-revs
file so it doesn't show up in git blame (GitHub also honors this file).I've left out the
rst-backticks
check andcodespell
for now, but those will also be useful for correctness, for example: