DRIVERS-2790 Add more linting and integrity checks #1464
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: