Skip to content

Add Pre-Commit Config#214

Closed
allerter wants to merge 2 commits intojohnwmillr:masterfrom
allerter:add-pre-commit
Closed

Add Pre-Commit Config#214
allerter wants to merge 2 commits intojohnwmillr:masterfrom
allerter:add-pre-commit

Conversation

@allerter
Copy link
Contributor

@allerter allerter commented Jun 6, 2021

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 flake8 and doc8. 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.

allerter 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.
@allerter allerter added this to the 3.1.0 milestone Jun 6, 2021
@johnwmillr johnwmillr force-pushed the master branch 6 times, most recently from b72d04e to 5ee1136 Compare April 4, 2025 05:48
@johnwmillr
Copy link
Owner

Closed by #300.

@johnwmillr johnwmillr closed this May 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants