O Git ajuda equipes diversificadas e distribuídas a trabalhar em uma base de código unificada. Com esse poder vem uma responsabilidade: deixar boas descrições de suas mudanças.

As mensagens de commit são descrições curtas de cada commit em um sistema de controle de versão como o Git. Ao confirmar alterações em seus arquivos de projeto, você deve fornecer uma mensagem explicando o que elas fazem ou por que você as fez.

As mensagens de confirmação servem como uma forma de documentação e comunicação. Eles desempenham um papel crucial na manutenção de um histórico de versão claro e organizado de um projeto. Aprenda a escrever boas mensagens de commit e os outros membros de sua equipe apreciarão ainda mais seu trabalho.

Estrutura de uma boa mensagem de commit

Um bom exemplo de uma mensagem de confirmação inclui quatro seções: Tipo, Descrição, Corpo e Rodapé.

Igual a:

: 
[corpo opcional]
[rodapé opcional]

Tipo

O tipo descreve o tipo de alteração feita no commit atual. Você pode usar qualquer sistema que faça sentido para suas circunstâncias. Por exemplo, aqui estão alguns exemplos de palavras-chave que você pode usar para sinalizar cada tipo de alteração, juntamente com exemplos de uso:

instagram viewer

  • façanha: suas alterações introduzem um novo recurso.
  • consertar: você corrige um bug.
  • refatorar: sua alteração refatora o código sem corrigir um bug ou adicionar um novo recurso.
  • teste: você faz qualquer alteração relacionada ao teste. Por exemplo, quando você escrever testes com Jest ou qualquer outra estrutura de teste você escolhe.
  • tarefa: alterações não relacionadas a uma correção, recurso ou teste. Por exemplo, atualizando dependências.
  • documentos: quando você atualiza a documentação.
  • estilo: mudanças que não afetam o significado do código, como adicionar espaço em branco, faltar ponto e vírgula, etc.
  • desempenho: mudanças relacionadas a melhorias de desempenho.
  • construir: quando você faz alterações que afetam os arquivos de compilação.
  • ci: mudanças relacionadas à integração contínua.
  • reverter: ao reverter para um commit anterior.

Descrição

A “descrição” de uma mensagem de commit é um resumo conciso e descritivo das mudanças feitas no commit. Ele serve como um título que captura a essência do commit.

Ao escrever a descrição, tenha em mente o seguinte:

  • Torne-o claro e específico o suficiente para descrever o commit rapidamente.
  • Faça-o breve e conciso. Idealmente, limitar a 50 caracteres ou menos seria o melhor.
  • Escreva no tempo presente, mesmo que esteja descrevendo mudanças já feitas.
  • Faça uso do modo imperativo ao escrevê-lo.
  • Comece com letra maiúscula.
  • Não termine com um ponto.

Por exemplo:

façanha: Implemente a alternância do modo escuro para a página inicial

Este exemplo mostra como você pode escrever a descrição para um commit que implementa o modo escuro. Ele usa o façanha tipo porque introduz um novo recurso.

Corpo (opcional)

A seção do corpo de uma mensagem de confirmação fornece detalhes e contexto adicionais sobre as alterações feitas na confirmação. Você nem sempre precisará de um corpo, mas pode ajudar a fornecer mais informações, explicar o raciocínio de uma mudança ou descrever quaisquer considerações técnicas.

Aqui estão algumas coisas a serem observadas ao escrever a seção do corpo de uma mensagem de confirmação:

  • O Git nunca quebra automaticamente o texto, portanto, coloque-o manualmente em 72 caracteres quando você escreve o corpo. Isso dá ao Git espaço suficiente para recuar o texto, tornando-o mais legível.
  • Use o corpo para explicar o que aconteceu na mudança, por que você fez a mudança e o raciocínio por trás de sua mudança.
  • Você precisa deixar uma linha em branco entre a linha de descrição e o corpo. Isso permite ao Git distinguir entre eles.
  • Se o commit introduzir várias alterações ou afetar diferentes áreas da base de código, considere o uso de marcadores ou parágrafos para detalhar as modificações. Isso melhora a legibilidade e ajuda os leitores a entender os diferentes aspectos do commit.

Por exemplo:

façanha: Adicionar GitHub como um provedor OAuth
Integre o GitHub como um provedor OAuth para permitir 
autenticação com contas do GitHub.


- Implementar fluxo de autenticação OAuth com GitHub API
- Configure os pontos de extremidade e as configurações necessárias para a autenticação do GitHub
- Atualize a interface do usuário para incluir a opção de login do GitHub

O exemplo acima mostra uma boa mensagem de confirmação do Git para um recurso que adiciona GitHub como provedor OAuth à sua aplicação. Esta mensagem de confirmação tem uma linha de resumo concisa (50 caracteres ou menos), um texto explicativo mais detalhado (quebrada para cerca de 72 caracteres) e marcadores para informações adicionais.

A seção de rodapé em uma mensagem de confirmação é uma parte opcional que fornece informações adicionais ou metadados relacionados à confirmação. Normalmente é colocado após a seção do corpo, separado por uma linha em branco. O rodapé pode incluir vários tipos de informações, como referências a problemas relacionados, tags ou notas especiais.

Ao fazer referência a problemas, solicitações pull ou outros itens relacionados, use a sintaxe ou o formato apropriado exigido pelo sistema de rastreamento de problemas do seu projeto. Isso garante que as referências sejam devidamente reconhecidas e vinculadas.

Por exemplo:

façanha: Adicionar GitHub como provedor OAuth
Integre o GitHub como um provedor OAuth para permitir 
autenticação com contas do GitHub.


- Implementar fluxo de autenticação OAuth com GitHub API
- Configure os pontos de extremidade e as configurações necessárias para a autenticação do GitHub
- Atualize a interface do usuário para incluir a opção de login do GitHub
Resolve: #123
Veja também: nº 456, nº 789

O rodapé faz referência ao problema relacionado nº 123 e menciona outros problemas relacionados nº 456 e nº 789 para contexto adicional.

Adicionando a mensagem de confirmação

Você pode escrever mensagens de commit usando o -m sinalizador seguido pela mensagem de confirmação entre aspas (opcional, mas recomendado).

O -m sinalizador é ideal para mensagens de confirmação curtas, geralmente incluindo o tipo e a descrição.

Por exemplo:

git commit -m "tarefa: Alterar linter para ESlint"

No entanto, quando sua mensagem de confirmação exigir mais detalhes, como um corpo e um rodapé, seria melhor escrever a confirmação em um editor de texto ou IDE.

Alternativamente, você pode escrever longas mensagens de commit em um arquivo de texto e usar o --arquivo sinalizador para especificar as mensagens de confirmação como o conteúdo do arquivo de texto.

Por exemplo:

git commit --file commit_message.txt

Ao executar o comando acima, o git usará o conteúdo do arquivo como a mensagem de confirmação.

Você também pode dizer ao git para abrir seu editor padrão para escrever uma mensagem mais longa. Se você tiver a variável de ambiente GIT_EDITOR ou EDITOR definida, o git abrirá esse programa quando você executar um bare git commit comando.

Por que você deve escrever boas mensagens de commit

Escrever boas mensagens de commit é crucial para uma colaboração efetiva e manutenção do código. Mensagens claras e descritivas ajudam na compreensão, depuração e revisões de código. Eles podem até contribuir com a documentação do projeto ou notas de lançamento.

Eles permitem o compartilhamento de conhecimento, integração suave e controle de versão de suporte. Priorizar mensagens de confirmação de qualidade aprimora os processos de desenvolvimento e garante a manutenção da base de código.