openkata/commit-conventions
Enforces Conventional Commits format and branch naming conventions, validating commit message structure (type/scope/description header), suggesting branch name patterns (feature/*, fix/*, hotfix/*), and enforcing breaking change notation. Use when the user is about to commit, creating a branch, reviewing commit history, preparing a pull request, setting up commit linting, or asking about commit message format, branch naming, or Conventional Commits.
97
97%
Does it follow best practices?
Impact
97%
1.03xAverage score across 3 eval scenarios
Passed
No known issues
commit-format.mdreferences/
Commit Message Format
Header
type(scope): description
- Scope: Optional. Area of the codebase affected.
- Description: Imperative mood, lowercase first word, no trailing period.
- Length: Max 72 characters for the entire header line.
Types
feat, fix, docs, style, refactor, test, chore,
perf, ci, build
Body
Optional for simple, self-evident changes (typo fixes, dependency bumps, single-line config changes). Required when:
- The change involves a decision or trade-off
- The fix isn't immediately obvious from the diff
- The change affects behavior in non-obvious ways
- Someone might ask "why did they do it this way?"
Leave a blank line between header and body. Wrap at 72-74 characters.
Footer
Fixes #123— closes the issue when mergedCloses #456— same as FixesRelates to #789— references without closingBREAKING CHANGE: description— for breaking changesCo-authored-by: Name <email>— for co-authors
Examples
Simple commit:
feat(dashboard): add loading spinner to dashboard pageBug fix with body and footer:
fix(auth): fix race condition in authentication middleware
The middleware was checking token validity before the database
connection was fully established, causing intermittent 401 errors
during server startup.
Adds a connection readiness check before token validation with
retry and exponential backoff (max 3 attempts).
Fixes #142