docs: replace pre-commit by prek in the contrib instructions#490
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
|
roedoejet
approved these changes
May 27, 2026
Collaborator
roedoejet
left a comment
There was a problem hiding this comment.
lgtm, thanks for adding!
This file contains hidden or 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
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.
PR Goal?
Replace pre-commit by prek https://prek.j178.dev/
prek installinstead ofpre-commit installFixes?
my growing annoyance with pre-commit, and really, just cause all these new rust-based tools actually are nicer. :)
I've actually been using prek for months now, but I didn't to impose it on anyone. When I mentioned it to Samuel, he chided me for now sharing the joy, so this PR is me finally doing that sharing.
It's not a huge difference, but it's still enough difference I found it worth switching, especially given how trivial it is to switch.
How to test?
Install
prek:pip install -e ".[dev]", or just dopip install prek, or evenuv tool install prek` for a global installRemove the pre-commit hook if you installed it before
(Re-)install the hook:
Now commit some changes.
prekwill have to install everything in.pre-commit-config.yamlfresh, so the first time will be slow, though not nearly as slow as when usingpre-commit, and subsequent times will be nice and fast.Confidence?
high
Version change?
no
Related PRs?
EveryVoiceTTS/EveryVoice#798
ReadAlongs/Studio#303