ci: align commit-check + add license, pre-commit hooks#30
Merged
Conversation
The package.json declared MIT and the README linked a license badge to ./LICENSE, but the LICENSE file itself was never committed. GitHub detects licenses from the file, not package.json, so the repo showed no license. Adds the standard MIT text.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
commit-check ran with no config, so its built-in defaults only allowed feat/fix/chore branch prefixes. This rejected docs/, refactor/, perf/, style/, test/, ci/, and build/ branches even though CONTRIBUTING.md and labeler.yml document them as valid. Adds .github/cchk.toml allowing the full documented set for both branches and commit messages.
jal-co
changed the title
jal-co
changed the title
2 tasks
jal-co
added a commit
that referenced
this pull request
May 31, 2026
* ci: add pre-commit hooks for commit-check 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. * docs: sync CONTRIBUTING with global versioning conventions 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.
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
Repo conventions + meta fixes:
LICENSE— adds the missing MIT file (Copyright (c) 2026 Justin Levine)..github/cchk.toml— commit-check policy allowing every branch/commit type the project documents..pre-commit-config.yaml— local hooks running the same commit-check validation as CI, plus CONTRIBUTING setup docs.Why
LICENSE:
package.jsondeclared MIT and the README badge linked to./LICENSE, but the file was never committed — so GitHub showed no license and the badge link was broken.commit-check config: This PR's first CI run failed the branch check. commit-check ran with no config, so its defaults only allowed
feat/fix/chore— rejectingdocs/,refactor/,perf/,style/,test/,ci/,build/even thoughCONTRIBUTING.mdandlabeler.ymldocument them.cchk.tomlaligns the tool with the project's own conventions (Conventional Commits 1.0.0 + Conventional Branch).pre-commit: Contributors now get the same branch + commit-message checks locally (before pushing) that CI enforces, sharing the same
cchk.tomlpolicy.Closes #
Type
docs— Documentationci— CI/CD changesHow
LICENSE: exact SPDX MIT text → GitHub detector shows the MIT badge.cchk.toml:allow_branch_types/allow_commit_typesset to the documented set; bot authors ignored. Verified with thecommit-checkCLI — valid types pass, bogus types fail (config is read, not bypassed)..pre-commit-config.yaml: pins commit-checkv2.7.0,check-message(commit-msg) +check-branch(pre-push). Documented one-time setup in CONTRIBUTING.Testing
commit-check --branch/--message— pass locallynpm run lint(tsc --noEmit) — passesnpm test— 62/62 passScreenshots
N/A — repository metadata / CI config.