Background & Reference
Following up on the discussion in #222 (comment by @AnnoDomine) and the work on release automation in #228 and #229, we need standardized commit messages to support automated changelog generation and SemVer tracking.
Proposed changes
- Adopt Conventional Commits 1.0.0: Standardize on standard types:
feat: (correlates with SemVer MINOR)
fix: (correlates with SemVer PATCH)
docs:, chore:, refactor:, test:, ci: (maintenance/no release trigger)
BREAKING CHANGE: footer or ! (correlates with SemVer MAJOR)
- Enforce locally via pre-commit:
- Configure a
pre-commit hook (e.g., using commitizen or conventional-pre-commit on the commit-msg stage).
- Document how contributors install and enable the hook via
pre-commit install --hook-type commit-msg.
- Documentation:
- Add a brief commit message guide to
CONTRIBUTING.md with examples.
Questions / Alignment
Related Issues
Background & Reference
Following up on the discussion in #222 (comment by @AnnoDomine) and the work on release automation in #228 and #229, we need standardized commit messages to support automated changelog generation and SemVer tracking.
Proposed changes
feat:(correlates with SemVerMINOR)fix:(correlates with SemVerPATCH)docs:,chore:,refactor:,test:,ci:(maintenance/no release trigger)BREAKING CHANGE:footer or!(correlates with SemVerMAJOR)pre-commithook (e.g., usingcommitizenorconventional-pre-commiton thecommit-msgstage).pre-commit install --hook-type commit-msg.CONTRIBUTING.mdwith examples.Questions / Alignment
Related Issues