CommitMe

CommitMe provides a Pre-commit hook, GitHub Action, and Command Line Interface for validating commit messages against the Conventional Commits specification;

• Rich error messages to help identify non-compliances:

• Adds labels (feature, fix, or breaking) to your Pull Request
• Limiting Conventional Commits scope and types.

Please refer to the document related to your environment for more details on the usage instructions:

• GitHub Actions
• Command Line Interface
• Pre-commit Hook

Configuration

Please refer to the Global Configuration documentation for details on how to configure CommitMe.

Claude Code plugin

A Claude Code plugin makes a Claude session get the commit message right before the commit, instead of in CI afterwards. It adds:

• a hook on git commit (-m, -F <file> or a heredoc message) that validates the message with the commit-me bundled in this repository and your .commit-me.json (or .github/.commit-me.json). A non-compliant message is denied with commit-me's error text and the allowed types and scopes, so Claude rewrites it. Merges, fixup!/squash! subjects and git commit --amend --no-edit pass. When the check cannot run (Node.js missing), the commit goes ahead with a note; work is never blocked.
• a conventional-commits skill: which type to use, scopes from your config, the subject form and breaking changes.

/plugin marketplace add dev-build-deploy/claude-plugins
/plugin install commit-me@dev-build-deploy

See dev-build-deploy/claude-plugins to enable it for every session of a repository. The plugin's tests run with npm run test:plugin.

Contributing

If you have suggestions for how commit-me could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

License

• MIT © 2023 Kevin de Jong <monkaii@hotmail.com>
• CC-BY-3.0 © 2023 Free Software Foundation Europe e.V.