Gerador de mensagem de commit (Conventional Commits)
Monte a mensagem de commit no padrão Conventional Commits, com tipo, escopo, corpo, mudança incompatível e rodapés.
- Roda no seu navegador
Resultado
O resultado aparece aqui.
O formato da mensagem
tipo(escopo)!: descrição, uma linha em branco, corpo opcional, uma linha em branco, rodapés opcionais
O escopo e o ! são opcionais: o ! depois do tipo marca uma mudança incompatível. Por exemplo, feat(login): adiciona login com Google.
Uma mudança incompatível com a explicação no rodapé fica: feat(api)!: remove a rota antiga / / BREAKING CHANGE: a rota /v1/usuarios deixou de existir
Os tipos
A especificação só define dois tipos: feat, que corresponde a uma versão menor (MINOR), e fix, que corresponde a um conserto (PATCH). Os outros tipos oferecidos (docs, style, refactor, perf, test, build, ci, chore e revert) são recomendação usada por muitos times, não parte da especificação.
- Escopo: letras minúsculas, números e . _ / -, sem espaço.
- Rodapés: cada linha no formato token: valor ou token #valor, como Closes #128. O cabeçalho do exemplo completo tem 28 caracteres.
- O cabeçalho costuma ser mantido abaixo de 72 caracteres, mas isso é prática, não regra da especificação.
Perguntas frequentes
Como escrever uma mensagem de commit no padrão conventional commits?
Comece pelo tipo, o escopo opcional e dois-pontos, e descreva a mudança no imperativo: feat(login): adiciona login com Google
Como marcar um breaking change nos conventional commits?
Marque o tipo com ! antes dos dois-pontos e, se quiser, explique no rodapé BREAKING CHANGE. A ferramenta faz as duas coisas quando você marca a opção e preenche a explicação.
Quais são os conventional commits types?
A especificação define feat e fix. Os demais, como docs, refactor, test e chore, são tipos recomendados que muitos projetos adotam.