Boas práticas para mensagens de commit

Imagine consultar o histórico do seu projeto. Sem mensagens de confirmação claras, seria como ler um diário com páginas em branco!

Boas mensagens de confirmação são essenciais para entender por que as alterações foram feitas, o que foi alterado e como essas alterações afetam o projeto. Isso ajuda você e sua equipe a encontrar e corrigir erros, revisar o código e integrar novos membros.

Uma mensagem de confirmação padrão do Git tem duas partes principais:

• Linha de Assunto: uma única linha concisa que resume a alteração.
• Corpo (Opcional): uma explicação mais detalhada, separada do assunto por uma linha em branco.

Pense nisso como um e-mail: uma linha de assunto para uma leitura rápida e um corpo para os detalhes.

A linha de assunto é a parte mais importante. Estas são as regras:

• Seja conciso: mantenha o texto com menos de 50 a 72 caracteres.
• Modo imperativo: comece com um verbo no presente (por exemplo, "Adicionar recurso", e não "Recurso adicionado" ou "Adicionando recurso").
• Coloque a primeira letra em maiúscula: essa é uma prática padrão que melhora a legibilidade.
• Não use ponto final: não termine a linha de assunto com um ponto.

Veja alguns exemplos de linhas de assunto boas e ruins:

• Boa: Fix: broken login button
• Boa: Feat: implement user profile page
• Ruim: Fixed a bug in the login system that was causing issues. (Muito longa e no passado)
• Ruim: updates (Vaga demais)

Busque clareza e brevidade!

O corpo da confirmação é onde você explica a motivação da alteração, o contexto e quaisquer detalhes que não sejam óbvios apenas pelo código.

Use-o quando sua alteração precisar de mais explicações do que a linha de assunto pode oferecer. Limite as linhas a aproximadamente 72 caracteres para melhorar a legibilidade nas ferramentas do Git.

Ao escrever o corpo:

• Explique por que a alteração foi feita, não apenas o que foi alterado.
• Descreva quaisquer concessões ou decisões de projeto.
• Mencione possíveis efeitos colaterais ou áreas que mereçam atenção.
• Mantenha uma linha em branco entre o assunto e o corpo.

Isso fornece um contexto valioso para quem ler a mensagem no futuro.

Veja como poderia ser uma mensagem de confirmação completa e bem estruturada:

Muitas equipes adotam uma convenção na qual a linha de assunto começa com um prefixo de tipo. Isso ajuda a categorizar rapidamente as alterações.

Entre os prefixos comuns estão:

• feat: (novo recurso)
• fix: (correção de erro)
• docs: (alteração na documentação)
• style: (estilo do código, sem alteração funcional)
• refactor: (refatoração do código)
• test: (adição de testes)
• chore: (manutenção e alterações no processo de compilação)

É uma ótima prática vincular suas confirmações a problemas ou solicitações de pull relacionados no sistema de gerenciamento do seu projeto (por exemplo, GitHub Issues ou Jira).

Você pode fazer isso incluindo frases como Closes #123, Fixes #45 ou Refs #67 na sua mensagem de confirmação, geralmente no corpo. Isso conecta automaticamente suas alterações de código à tarefa que está sendo acompanhada.

De acordo com as práticas recomendadas, quais das opções a seguir são características de uma mensagem de confirmação do Git bem escrita?

Você aprendeu que mensagens de confirmação bem elaboradas são essenciais para a clareza e a colaboração em um projeto. Ao seguir estas práticas recomendadas, você transforma o histórico do projeto em um recurso valioso!

• Mantenha as linhas de assunto concisas e no modo imperativo.
• Use o corpo para explicar 'por quê' uma alteração foi feita.
• Considere usar prefixos de tipo para categorizar as alterações.
• Vincule problemas ou solicitações de pull para fornecer contexto.

Boas confirmações!