docs(pre-commit): canonical 21-hook template + tier docs (#186)#222
Merged
Conversation
Adds `templates/pre-commit/.pre-commit-config.yaml` as the versioned, copy-pasteable source of truth for PulseEngine Rust repositories, and `docs/pre-commit.md` documenting the rationale per hook plus an advisory T1 / T2 / T3 tier system. Each hook in the template carries an inline tier annotation so adopters can grep-trim to their assurance level. `CUSTOMIZE` markers flag the per-project knobs (rust-toolchain pinning, artifact-path globs, mutation crate selection). Refs: #186
5 tasks
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
2 tasks
avrabe
added a commit
that referenced
this pull request
Apr 30, 2026
…246) Workspace, vscode-rivet, and npm root package versions bumped to 0.7.0. Platform packages stay on the release-npm.yml override path. What's in 0.7.0: - feat(schema): rivet schema migrate Phase 2 (#242) — full git-rebase conflict-resolution UX. Conflict markers in YAML, --continue, --skip, --edit. New MigrationConflict invariant in rivet docs check. - feat(docs-check): subcommand-coverage gate (#241) — walks the live clap CLI tree and asserts each path has an embedded docs topic. Default warn-only; --strict makes it enforcing. - feat(validate): prose-mention-without-typed-link warning (#234, closes #207). - feat(schemas): vv-coverage repo-status type (#232, partial #188). - feat(mutants): canonical cargo-mutants template (#229, closes #185). - docs(pre-commit): canonical 21-hook template (#222, closes #186). - fix(ci): Release workflow now idempotent on existing tag (#244). Known issue: v0.5.0 / v0.5.1 / v0.6.0 release pages have no binary assets attached because the workflow's Create Release step failed on each (race with manual gh release create). The fix in #244 lands in this release; v0.7.0 onward is unaffected. Older releases need a manual gh release upload to backfill. Verified: cargo check, cargo clippy --workspace -- -D warnings, cargo test -p rivet-cli, rivet docs check (clean), rivet docs check --coverage reports 48/81 paths covered (warn-only). Trace: skip
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.
Refs: #186
Summary
First in-scope cut at the canonical pre-commit template story. Two new files:
templates/pre-commit/.pre-commit-config.yaml— copy-pasteable source of truth, mirroring rivet's own 21-hook config but withCUSTOMIZE:markers for per-project knobs.docs/pre-commit.md— per-hook rationale table, standard-clause mapping, advisory T1 / T2 / T3 tier system, adoption recipe, drift policy.Acceptance-criteria mapping (from #186)
templates/pre-commit/.pre-commit-config.yamldocs/pre-commit.mdper-hook tablepulseengine/rivet; needs a session with broader org scope (or manual filing)Why draft
Two open decisions need maintainer review before this leaves draft:
cargo +stablepinning. Hard-coded for the template; if adopters should template-substitute the channel from theirrust-toolchain.tomlinstead, say the word and I'll switch the example to a placeholder.Test plan
rivet validateis unaffectedGenerated by Claude Code