Conventional commit checker
Check a commit message against the Conventional Commits 1.0 style.
Loading the tool…
What it does, how to use it, and questions
What it does
Conventional Commits format subjects as type(scope): description, with an optional ! for breaking changes and a body/footers after a blank line.
This checker parses the subject and reports type, scope, breaking marker and common length problems. It does not run your git hooks.
How to use it
- Paste the full commit message.
- Read the parse result and errors.
- Fix the subject and copy again.
Things to watch for
- Types are conventional (
feat,fix, …) but your repo may allow others. Unknown types are warned, not hard-failed unless you require a list. - The description should not end with a period.
Questions
- What types are recognised?
- feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert. Others are flagged as non-standard.
- How do I mark a breaking change?
- Add
!after the type/scope, or aBREAKING CHANGE:footer. - Does this create a commit?
- No. It only checks the text you paste.
- Is the message uploaded?
- No.