Skip to content

Enforce Conventional Commits specification with pre-commit hook #236

Description

@AnnoDomine

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

  1. 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)
  2. 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.
  3. Documentation:
    • Add a brief commit message guide to CONTRIBUTING.md with examples.

Questions / Alignment

Related Issues

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions