Conventional Commit Generator

Pick a commit type and fill in scope, subject, body and footers to get a message that follows the Conventional Commits format.

Use the tool

Why this tool exists

Teams that generate changelogs or version numbers from commit history need messages in a strict shape. One missing colon, a capitalised subject or a breaking change written in the wrong place and the release tooling skips the commit or bumps the wrong number.

This generator assembles the header as type(scope): subject, adds an exclamation mark when you describe a breaking change, and writes the BREAKING CHANGE footer in the right spot, followed by any other footers such as Closes #12. It lowercases the first letter of the subject and strips a trailing full stop, in line with common convention, and warns when the first line passes 72 characters. It is useful when you are learning the format or setting up semantic-release. It runs locally.

How to use it

  1. Choose the commit type, such as feat, fix or docs.
  2. Enter an optional scope and a short subject in the imperative mood.
  3. Add a body, a breaking change description and footers if needed; use \n for new lines.
  4. Copy the message into git commit.

Frequently asked questions

What do the types mean?

feat adds a feature, fix repairs a bug, and the others cover docs, style, refactor, perf, test, build, ci, chore and revert. Release tools commonly treat feat as a minor bump and fix as a patch bump.

How is a breaking change marked?

If you fill in the breaking change field, the header gets an exclamation mark after the type or scope and a BREAKING CHANGE footer is added. Most tools read either signal as a major release.

How do I add several lines to the body?

Type the characters backslash and n where you want a line break. The tool turns them into real newlines. The same works in the footer field.

Why does it add a note about 72 characters?

Long first lines are cut off in many git views. The tool appends a note when the header exceeds 72 characters, so shorten the subject and remove that note before committing.