chore: add shared git hooks and CONTRIBUTING - #2
Merged
Conversation
Move the pre-commit (main-guard + fmt + clippy) and pre-push (test) hooks into a tracked .githooks/ dir so they can be enabled per-clone via core.hooksPath. Document setup and workflow in CONTRIBUTING.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
What
Moves the local git hooks into a tracked
.githooks/directory so they can be shared across clones, and addsCONTRIBUTING.md..githooks/pre-commit— forbids direct commits tomain/master, runscargo fmt --all --check, and runscargo clippy --all-features --all-targets -- -D warnings..githooks/pre-push— runscargo test --all-features.CONTRIBUTING.md— documents the one-timegit config core.hooksPath .githookssetup, what each hook does, the feature-branch/PR workflow, and the CI checks.Why
Previously the hooks lived in
.git/hooks/(local, not shared on clone). Tracking them in.githooks/lets every contributor opt in with a singlecore.hooksPathsetting and keeps the local gate in lockstep with CI (fmt, clippy, tests).Enabling
core.hooksPathis a per-clone local setting (not committed), so each clone runs once:Verification
100755).main; pre-push runs the full suite (24 tests + doctest).🤖 Generated with Claude Code