Build conventional commit

Build a Conventional Commit header, body, and breaking-change footer.

freeworks offlinenothing uploaded
ToolConventional Commit Builder
Input
Output
—
Put this on your own site

The frame below runs the same code as this page, in the reader's own browser. Nothing is sent to us, and nothing is sent to you.

Pick a dark background and the text and panels follow it, so the frame stays readable on a dark page.

Preview

How it works

Type, optional scope, colon, description, body, and footers are joined into the Conventional Commits grammar. Breaking changes use ! or a BREAKING CHANGE footer.

  • feat, fix, docs, and chore map to release-note groups.
  • Projects can extend the type vocabulary.

Worked example

Feature with scope and issue ref
Build a commit message for a new auth feature referencing an issue
Input
											Type: feat
Scope: auth
Description: add OAuth2 login with Google provider
Issues: #234
Output
												feat(auth): add OAuth2 login with Google provider

Refs: #234

When to use this

Commitlint, semantic-release, and automated changelogs build conventional messages.

Edge cases

  • A missing colon breaks the header grammar.
  • A BREAKING CHANGE footer can require a major release from a fix.
  • A colon in scope must not steal the header separator.

References