How to use Conventional Commit Message Builder
- Choose Build a message, or Check a message to inspect one you already have.
- Pick a type, add a scope when the project uses them, and write one short description of the change.
- Add the body and any footers such as Closes #12, and turn on the breaking marker when callers must change something.
- Press Build commit message, read the notes, and copy the message.
Example: Conventional Commit Message Builder
Build a breaking-change message with an issue footer.
Options
- Type
- The noun that says what kind of change this is: feat for a feature, fix for a bug fix, docs, style, refactor, perf, test, build, ci, chore or revert. The list is the common set, and the checker only notes a type outside it rather than failing the message.
- Scope
- One word naming the part of the project that changed, written in brackets after the type, such as feat(parser). A space or a bracket inside the scope is refused because it would break the header shape.
- Breaking change
- The checkbox adds the ! marker before the colon and writes the note as a BREAKING CHANGE footer. The note is required, because the marker alone does not tell a reader what to change.
- Footers
- One footer per line, written as Token: value or Token #value, such as Closes #12 or Reviewed-by: Ana. A line that looks like a footer but does not follow that shape is reported rather than quietly treated as body text.
Supported inputs and limits
Where your input is processed
This tool processes your input in this browser. Your text and files are not uploaded to UseFreeTools. Check this tool's limits for anything it may save on your device.
Why the shape matters more than the wording
A conventional message is made of a header that other tools can parse, an optional body that explains why the change was made, and footers that point at issues and reviewers. The header has to keep its three parts in order, and the blank line before the body is what stops a release tool from reading the first paragraph as part of the description.
Questions about Conventional Commit Message Builder
Do I need the ! marker when I write a BREAKING CHANGE footer?
No, either one marks the change. Using both is clearer, because the header carries the signal for anyone scanning a log and the footer says what callers must do.
What counts as a valid footer line?
A token followed by a colon and a value, or a token followed by an issue reference with no colon, such as Closes #12. BREAKING CHANGE is the one token that holds a space.
Why does the checker only warn about my type?
The specification allows any noun as the type, so a type outside the common list is worth knowing about but is not a broken message. A missing colon or a missing description is a real problem and is reported as one.
Is the message sent to a server?
No. The parts are assembled and checked in this page, and the text you copy never leaves the browser.