Guia prático: Como escrever boas mensagens de commit no Git

Como escrever boas mensagens de commit no Git?

Mensagens de commit bem escritas são fundamentais para manter um histórico organizado e facilitar a compreensão do que foi alterado no código. Um commit com uma descrição clara permite que outros desenvolvedores entendam as mudanças sem precisar analisar o código em detalhes.

Estrutura ideal de uma mensagem de commit

O formato recomendado para mensagens de commit segue três princípios:

1. Linha de resumo: Uma descrição curta e direta da mudança.
2. Corpo opcional: Explicação mais detalhada se necessário.
3. Referência opcional: Ligação a issues, tickets ou pull requests relacionados.

Exemplo de um bom commit:

git commit -m "Corrige bug na exibição de preços no carrinho"

Se precisar de uma descrição mais longa, use:

git commit

Isso abrirá um editor para escrever uma mensagem mais detalhada. Um exemplo correto seria:

Corrige bug na exibição de preços no carrinho

- Ajusta a formatação do preço para duas casas decimais.
- Evita exibição de valores negativos.
- Relacionado ao ticket #321.

Dicas para boas mensagens de commit

• Use o tempo verbal imperativo (exemplo: "Corrige erro" em vez de "Corrigido erro").
• Seja objetivo e explique o porquê da mudança, não apenas o que foi alterado.
• Se possível, referencie issues ou tarefas relacionadas.
• Escreva mensagens curtas e diretas.

Como editar a última mensagem de commit

Se você cometeu um erro ou esqueceu de adicionar detalhes na mensagem, pode editá-la com:

git commit --amend -m "Nova mensagem corrigida"

Isso sobrescreverá a última mensagem de commit sem criar um novo commit.

Por que escrever boas mensagens de commit é tão importante?

Mensagens de commit são um dos elementos mais importantes na manutenção de um projeto bem estruturado. Quando o histórico de commits é bem escrito, facilita a colaboração entre desenvolvedores e ajuda a entender rapidamente o que foi alterado no código.

Um dos problemas comuns em projetos é a falta de padronização nas mensagens de commit. Em times grandes, isso pode tornar a revisão de código mais demorada e dificultar a identificação de alterações importantes. Por isso, muitas empresas adotam convenções como o 'Conventional Commits', onde mensagens seguem padrões como 'feat:' para novas funcionalidades e 'fix:' para correções de bugs. Essas boas práticas tornam o desenvolvimento mais ágil e organizado.

Algumas aplicações:

• Manter um histórico de alterações organizado
• Facilitar a revisão de código e depuração
• Melhorar a colaboração entre desenvolvedores
• Rastrear mudanças de forma eficiente
• Integrar com sistemas de gerenciamento de tarefas e CI/CD

Dicas para quem está começando

• Use sempre o tempo verbal imperativo, como 'Adiciona funcionalidade' em vez de 'Adicionando funcionalidade'.
• Evite mensagens genéricas como 'Update' ou 'Correção'.
• Seja claro e direto ao explicar as mudanças.
• Se precisar de mais detalhes, utilize um corpo de mensagem separado.
• Se cometer um erro, use 'git commit --amend' para corrigir sem criar outro commit.

Compartilhe este tutorial