Add Pre-Commit Config #214
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
June 6, 2021 10:47
We need them to be pinned to exact versions in order not to get different results when using tox/CI and pre-commit.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Pre-commit is an easy and straightforward way to run our checks before letting the commit go through. It's really useful to catch simple mistakes and then having to make another commit to fix those mistakes.
This pre-commit config creates hooks for
flake8anddoc8. We could possibly create hooks for creating docs or even running the unit tests, but since those tests take some time, it's better to leave them out.After #199 is merged, we should update the contributing guidelines in this PR to mention the config and then merge it.