Guia do Commit Amigão

A página defende que uma convenção compartilhada para mensagens de commit torna o histórico mais fácil de navegar, ajuda a manter um padrão entre desenvolvedores, preserva o contexto da mudança, melhora a manutenção do projeto no longo prazo e facilita a geração de changelog. Também apresenta uma estrutura de commit com tipo, escopo, assunto, corpo e rodapé.

Fichamento

#

• Sem padrão, o git log fica difícil de ler e de explorar.
• O time deve combinar uma convenção para estilo, conteúdo e metadados.
• O estilo deve tratar de sintaxe, gramática, capitalização e pontuação.
• O conteúdo deve informar o que e por que mudou, e não como foi feito.
• Os metadados devem registrar referências de issues, IDs ou pull requests.
• O formato proposto é <tipo>(escopo): assunto, seguido de corpo e rodapé.
• O assunto deve ter no máximo 50 caracteres, ficar em minúsculas e usar imperativo.
• Os tipos permitidos são feat, style, refactor, test, fix, docs e chore.
• O corpo deve ter no máximo 80 caracteres e contextualizar a mudança.
• O rodapé serve para indicar metadados, como issues encerradas pelo commit.