Add example of prek.toml configuration to README#156
Merged
ntBre merged 3 commits intoastral-sh:mainfrom Feb 11, 2026
Merged
Conversation
ntBre
approved these changes
Feb 11, 2026
Contributor
ntBre
left a comment
There was a problem hiding this comment.
Thank you! I'll apply the suggestions for a couple of nits, but this looks great! I also tested out the config and confirmed that it works well.
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
2 participants
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.
Summary
Add an example of
prek.tomlconfiguration to the README, showing how to use Ruff with prek instead of pre-commit.The example mirrors the
.pre-commit-config.yamlsetup already in the docs.Tried to keep it concise to avoid repeating information already explained in the pre-commit section.
Test Plan
No code changes; README only.
Reviewed formatting and consistency with existing README examples. Checked TOML syntax and comments.
closes #154