Como usar: Gerador de Conventional Commits
- Escolha o tipo da mudança —
featpara uma nova funcionalidade,fixpara a correção de um bug, ou docs, refactor, perf, test, build, ci, chore, style ou revert. - Adicione um escopo opcional (a parte do código que ele afeta) e uma descrição curta no imperativo: “adiciona”, não “adicionado”.
- Explique o quê e por quê no corpo; marque Breaking change e descreva a migração se os usuários precisarem mudar algo.
- Adicione rodapés como
Closes #123, corrija o que as checagens apontarem e depois copie a mensagem ou o comandogit commit.
O formato Conventional Commits
<tipo>[escopo opcional][!]: <descrição>
[corpo opcional]
[rodapé(s) opcional(is)]| Tipo | Use para | Mudança de versão |
|---|---|---|
feat | Uma nova funcionalidade | Minor (1.4.0 → 1.5.0) |
fix | A correção de um bug | Patch (1.4.0 → 1.4.1) |
! ou BREAKING CHANGE: | Uma mudança à qual os usuários precisam se adaptar | Major (1.4.0 → 2.0.0) |
| docs, style, refactor, perf, test, build, ci, chore, revert | Todo o resto | Nenhuma (a menos que seja breaking) |
Ferramentas como semantic-release, release-please e standard-version leem essas mensagens para escolher a próxima versão e gerar o changelog automaticamente; o commitlint as aplica no CI ou em um git hook. Mantenha o cabeçalho com menos de 72 caracteres, comece a descrição em minúsculas com um verbo no imperativo e não termine com ponto. Gere um changelog com o Gerador de Changelog e outros comandos git com o Gerador de Comandos Git.
Também pesquisado como: conventional commits, gerador de mensagem de commit, formato de mensagem de commit git, mensagens de commit semânticas, commitlint, commit feat fix, commit breaking change.
Ferramentas que combinam com: Gerador de Conventional Commits
- Calculadora Semver — Tudo sobre versões semânticas em um só lugar: compare duas versões, calcule o próximo major/minor/patch/prerelease e veja exatamente quais versões um range do npm como ^1.2.0 ou ~2.3 permite, com explicações em linguagem simples.
- Cheat Sheet do Git — Todos os comandos do Git que você usa no dia a dia — e os que precisa quando algo dá errado — explicados em uma linha.
- Gerador de fluxos de trabalho do GitHub Actions — Escolha sua pilha, gatilhos e etapas e receba um arquivo .github/workflows/ci.yml — instalação, cache, verificação de código, teste, compilação, uma matriz de versões e, opcionalmente, implantação no GitHub Pages, Vercel ou em um registro de contêineres.
- Gerador de LICENSE — Adicione a licença open source certa ao seu projeto em segundos.
Perguntas frequentes
O que é um conventional commit?
Uma mensagem de commit no formato tipo(escopo): descrição — por exemplo fix(auth): handle expired tokens — que as ferramentas conseguem ler para definir números de versão e montar changelogs.
Como marco uma breaking change?
Adicione ! depois do tipo ou do escopo (feat(api)!: …) e um rodapé BREAKING CHANGE: que explique o que mudou. Marque Breaking change aqui para obter os dois.
Qual é a diferença entre chore e refactor?
refactor muda a estrutura do código sem alterar o comportamento; chore cobre manutenção que não toca no comportamento do código-fonte, como atualizar dependências ou a configuração de ferramentas.
Como escrevo uma mensagem de commit com várias linhas pela linha de comando?
Use um -m por parágrafo: git commit -m "header" -m "body" -m "footer". O comando git aqui faz isso por você, com as aspas escapadas.
Posso instalar o Gerador de Conventional Commits como um aplicativo da web e usá-lo offline?
Sim. O Gerador de Conventional Commits é um aplicativo da web instalável (PWA) — instalado a partir do seu navegador, não baixado de uma loja de aplicativos. Clique em “Instalar aplicativo” na parte superior desta página no Chrome ou no Edge (Windows, macOS, Linux, ChromeOS) ou, no Android, use “Compartilhar” → “Adicionar à tela inicial” no iPhone e no iPad, ou “Arquivo” → “Adicionar ao Dock” no Safari 17+ em um Mac. Em seguida, ela se abre em uma janela própria com seu próprio ícone e, como é executada inteiramente no seu navegador, continua funcionando offline. O Firefox no desktop não permite a instalação de aplicativos da web. Como funciona a instalação.