Conventional Commit 生成器

描述

A new feature

0/72
填写上方字段以生成提交信息
类型说明
featA new feature
fixA bug fix
docsDocumentation only changes
styleFormatting, missing semi-colons, etc.
refactorCode change that is neither a fix nor a feature
perfPerformance improvement
testAdding or updating tests
buildBuild system or external dependencies
ciCI configuration and scripts
choreOther changes that don't modify src or tests
revertReverts a previous commit

When a Conventional Commit builder is the right tool

Use this page to assemble a Conventional Commits message from a type, optional scope, description, body, and footer. The preview updates as you type. It does not run git commit. For a project README, see README Template Generator.

Use cases

A simple feature or fix

Choose feat or fix, add a scope such as api if you want one, and write an imperative description. The output is a single header line.

Marking a breaking change

Check Breaking Change to put ! after the type or scope. Leave the footer blank if you want the automatic BREAKING CHANGE: line; fill the footer if you need something else, such as Closes #123.

How the message is built

The header, body, and footer are joined with blank lines. Empty body or footer fields are omitted (except the automatic breaking-change footer described above).

Example — a breaking feat with no custom footer
feat(api)!: add rate limits

BREAKING CHANGE: add rate limits

What this tool does not do

It does not lint against a repo’s commitlint config, add gitmojis to the message, or create a commit. Building stays in your browser.

How to use Conventional Commit Builder

  1. Select a type and optionally a scope, then write the description.
  2. Add a body or footer if needed, and check Breaking Change when the commit is breaking.
  3. Copy the message and paste it into your commit.

Frequently asked questions

How does Conventional Commit Builder work?

Pick a type, optionally add a scope, write a description, and optionally a body and footer. The message updates as you type and is empty until the description has non-whitespace text. The header is type(scope)!: description — the parentheses appear only when a scope is set, and the ! appears only when Breaking Change is checked. Type emojis in the picker are not copied into the message. Copy is disabled until there is a message.

Which types are available, and what does the 72-character counter do?

The types are feat, fix, docs, style, refactor, perf, test, build, ci, chore, and revert, with short English descriptions in the type reference. The counter measures the trimmed description only, not the whole header. Past 72 characters a warning appears (“Header is over 72 characters — consider shortening”), but the text is not truncated and Copy is not blocked.

When is a BREAKING CHANGE footer added?

If Breaking Change is checked and the footer field is left empty, a footer line BREAKING CHANGE: plus the description is appended after a blank line. If you type your own footer, that text is used instead and the automatic BREAKING CHANGE line is not added — you must include it in the footer yourself if you still want it. The header ! remains as long as the checkbox is on.

Does this create a Git commit? Is anything uploaded?

No. The page only builds the message text in your browser. You still run git commit (or a hook) yourself.

Related tools and guides

References

  • The Conventional Commits 1.0.0 specification describes the header, body, footer, and breaking-change markers this builder approximates.