Skip to main content

Boas Práticas para Mensagens de Commit no Git

Seguir padrões para as mensagens de commit é importante para manter um histórico claro e útil do projeto. Aqui estão algumas diretrizes:

Estrutura de Mensagem de Commit​

Siga uma estrutura padrão para suas mensagens:

<tipo>(<escopo>): <assunto>
<LINHA EM BRANCO>
<corpo da mensagem>
<LINHA EM BRANCO>
<rodapé>
  • Tipo: Indica o tipo de mudança (ex: feat, fix, refactor).
  • Escopo: Opcional, parte do código afetada (ex: login).
  • Assunto: Descrição breve da mudança.

Para mais informações sobre commits, acesse conventionalcommits.org.

Primeira Linha Clara e Concisa​

A primeira linha deve ser clara e sumarizar a mudança, com menos de 50 caracteres.

Uso do Modo Imperativo​

Escreva mensagens de commit no modo imperativo (ex: "Fix bug").

Capitalização Consistente​

Comece a mensagem com uma letra maiúscula.

Sem Ponto Final na Primeira Linha​

Não termine a primeira linha com um ponto.

Descrição Detalhada Quando Necessário​

Se necessário, inclua um corpo de mensagem detalhado após uma linha em branco.

Referência a Issues e Pull Requests​

Inclua referências no rodapé da mensagem (ex: "Closes #123").

Separação do Assunto e Corpo​

Use uma linha em branco para separar o assunto do corpo do texto.

Limitar Largura do Texto no Corpo​

Mantenha as linhas do corpo com menos de 72 caracteres.

Mensagens de Commit Atômicas​

Cada commit deve representar uma única mudança lógica.

Revisar Mensagens Antes do Push​

Revise as mensagens antes de realizar o push.

Seguindo essas práticas, você contribuirá para um histórico de projeto mais organizado e compreensível.