ZapKit

Conventional commit generator

Write consistent commit messages that changelog tools, semantic-release and your teammates understand, without memorising the format.

What are Conventional Commits?

Conventional Commits is a widely used specification for writing git commit messages in a predictable structure. Consistent messages make history easy to scan and let tools generate changelogs and decide version numbers automatically.

Pick a type, add an optional scope and write a short description. Add a body, mark a breaking change with an explanation, and list footer lines such as Closes #142. The message is assembled and wrapped as you type, with warnings for long first lines, and a git commit command is built from it.

How to use the Conventional commit generator

  1. 1.Choose a type and scope

    feat, fix, docs, refactor and more.

  2. 2.Describe the change

    A short summary, an optional body, breaking changes and footers.

  3. 3.Copy

    The message, or a git commit command with it.

Example: a new feature

Adding CSV export to reports and closing an issue:

First line
feat(reports): add CSV export
Body
what changed and why, wrapped at 72 characters
Footer
Closes #142

A message that produces a minor release and a neat changelog entry.

The format

A conventional commit starts type(scope): description, like fix(auth): handle expired sessions. An exclamation mark before the colon, or a BREAKING CHANGE footer, marks an incompatible change. The body explains what and why, wrapped at 72 characters, and footers reference issues or co-authors.

Tools read these messages to work out the next version: fix means a patch release, feat a minor one and a breaking change a major one. They also group changes into changelogs automatically.

Frequently asked questions

Should the description be capitalised?

Most projects use lowercase and no full stop, as in add CSV export.

What's the difference between chore and build?

build is for the build system and dependencies; chore covers other maintenance.

How long should the first line be?

Under 72 characters, ideally around 50, so it isn't cut off.

Does the command work on Windows?

It's quoted for Unix shells. In PowerShell, paste the message into your editor instead.

More Developer tools