docs: sync CONTRIBUTING conventions + recover pre-commit hooks#31
Merged
Conversation
Adds a pre-commit config running the same commit-check validation as CI (Conventional Commit messages, Conventional Branch names), so contributors catch issues before pushing instead of on the PR. Hooks share the .github/cchk.toml policy with CI. Documents the one-time setup in CONTRIBUTING. This change was authored alongside #30 but landed after that PR was merged, so it never made it onto main.
Adds a Versioning section documenting Semantic Versioning 2.0.0 and the feat->MINOR / fix->PATCH / breaking->MAJOR mapping, matching the new global AGENTS.md conventions. Notes the 0.y.z initial-development status, tag/release rules, and the automated publish-on-release flow. Also clarifies that breaking changes may use the BREAKING CHANGE footer in addition to the ! marker.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-actions
Bot
added
docs
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
1 participant
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
Two related contributor-doc / tooling changes:
.pre-commit-config.yaml+ the CONTRIBUTING "Git hooks" section) that were authored alongside ci: align commit-check + add license, pre-commit hooks #30 but landed after it was merged, so they never reachedmain.CONTRIBUTING.mdwith the updated global conventions — adds a Versioning section (Semantic Versioning 2.0.0) and clarifies breaking-change signalling.Why
Recovery: #30 was squash-merged at a 2-commit snapshot; the 3rd commit (
ci: add pre-commit hooks) was pushed after the merge and was silently dropped.mainis missing.pre-commit-config.yamland the "Git hooks" docs. This restores them.Versioning sync: The global AGENTS.md now documents Conventional Branch + Conventional Commits 1.0.0 + SemVer 2.0.0. CONTRIBUTING already covered branches and commits but had no versioning guidance — even though the package publishes to npm with
vX.Y.Ztags. This closes the gap.Closes #
Type
docs— Documentationci— CI/CD changesHow
.pre-commit-config.yaml: pins commit-checkv2.7.0,check-message(commit-msg) +check-branch(pre-push), sharing.github/cchk.tomlwith CI.feat→MINOR / fix→PATCH / breaking→MAJORmapping,0.y.zinitial-development note, tag/release rules. Verified the publish workflow triggers on GitHub Release (not raw tag push) and documented it accurately.BREAKING CHANGE:footer in addition to!.Testing
commit-check --branch/--message— pass locallynpm run lint(tsc --noEmit) — passesnpm test— 62/62 passScreenshots
N/A — contributor docs / CI config.