How to use Conventional Commit Message Builder
- Choose Build a message to assemble a new commit message, or Check a message and paste an existing message into its field.
- For a new message, select a type, add an optional scope and write a short description. Use the body to explain why the change was needed.
- Add issue or review footers when useful. If you select This is a breaking change, fill the required note describing what callers need to change.
- Build or check the message, read its problems and notes, then copy the text. Optional gitmoji and a POSIX shell command are available for projects that use them. Nothing is committed here.
Example: Conventional Commit Message Builder
Build a feature commit header for an upload retry change.
Options
- Type and scope
- The builder offers common types such as feat, fix and docs. The checker also accepts other alphabetic types with a note. An optional one-word scope appears in parentheses, for example feat(upload): add retry. Spaces and parentheses inside the scope are refused.
- Description and body
- Use one description line, up to 200 characters. A header over 72 characters receives a length note; that is writing advice rather than a specification limit. The optional body explains the change in paragraphs.
- Breaking change
- Selecting the checkbox makes this builder add both ! in the header and a BREAKING CHANGE footer. The builder requires a note. The specification also allows either marker on its own; a checker note about a missing explanation does not make a ! header invalid.
- Footers
- Enter one footer per line as Token: value or Token #value, such as Reviewed-by: Ana or Closes #12. The builder adds its breaking-change footer from the separate note when selected.
- Git command
- The optional command uses one quoted -m argument per paragraph for sh or bash. PowerShell and Windows command-prompt quoting differ. Review the command and repository before running it yourself.
- Gitmoji
- When selected, the mapped emoji goes at the start of the description after the type and colon. Keep this option for projects that use that convention; an ordinary message needs no emoji.
Supported inputs and limits
- Builds or checks plain text locally.
- The checker covers its documented header and one-line footer syntax; it is not a complete validator for every Conventional Commits footer form or a project’s release policy.
- The builder description is limited to 200 characters, while headers above 72 receive advice.
- Body and footer text uses line feeds, removes trailing spaces and collapses repeated blank lines.
- A blank line separates the header from later content.
More details
The builder requires an explanation when its breaking-change checkbox is selected; the specification itself allows ! or a BREAKING CHANGE footer to mark a break.
Optional command text uses POSIX shell quoting and is never executed.
This page does not inspect a diff or Git repository.
Where your input is processed
This tool does not upload your inputs. See the limits for anything saved on your device.
Explain the change your reader must understand
Use the type and scope to identify the change, then make the description specific enough to distinguish it from nearby commits. The body can explain the reason and tradeoff. For a breaking change, describe what a caller needs to do. The tool can check parts of the message structure, but it cannot infer those facts from your code.
Questions about Conventional Commit Message Builder
Do I need the ! marker when I write a BREAKING CHANGE footer?
The specification allows either ! in the header or a BREAKING CHANGE footer. This builder uses both when its checkbox is selected and requires an explanatory note. The checker can accept a ! header while noting that an explanation would help readers.
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.