Configurando um modelo de commit git: um guia passo a passo

Escrever boas mensagens de commit pode ser difícil quando você está trabalhando rapidamente. Sem uma estrutura, é fácil acabar com commits vagos e inconsistentes que retardam as revisões de código e o acompanhamento do projeto.

Um modelo de commit Git ajuda fornecendo um ponto de partida sempre que você cria um commit. Ele torna a escrita de mensagens claras mais rápida e mais consistente.

Neste artigo, você aprenderá exatamente como criar e usar um modelo de commit Git para melhorar a qualidade dos seus commits sem retardar seu fluxo de trabalho.

O que é um modelo de commit Git?

Um modelo de commit Git é um arquivo pré-escrito que aparece sempre que você executa git commit sem a flag -m. Ele fornece um formato estruturado ou lembretes para escrever melhores mensagens de commit.

Em vez de começar com uma tela em branco, você vê prompts úteis como:

# Título do commit (50 caracteres ou menos)

# Descrição: Por que esta mudança é necessária?

# Referência de problema (opcional):

Você pode editar essas linhas antes de finalizar seu commit.

Como criar um modelo de commit Git

Passo 1: Criar um arquivo de modelo

Crie um arquivo de texto em algum lugar do seu sistema, por exemplo:

nano ~/.gitmessage.txt

Dentro do arquivo, adicione uma estrutura simples:

# Título: (resumo curto, máximo de 50 caracteres)

# Descrição:
# - Explique por que esta mudança é necessária
# - Mencione qualquer contexto ou antecedentes

# Problemas Relacionados:
# - Referência a números de tickets ou links

Salve e feche o arquivo.

Passo 2: Configurar o Git para usar o modelo

Diga ao Git para usar este arquivo como modelo de mensagem de commit:

git config --global commit.template ~/.gitmessage.txt

Isso aplica o modelo em todos os seus repositórios.

Passo 3: Comece a usá-lo

Quando você criar um commit sem uma mensagem inline:

git commit

O Git abre seu editor padrão com o modelo carregado. Você preenche as seções, salva e fecha o editor para finalizar o commit.

Se você preferir fazer commits com mensagens inline -m para correções rápidas, ainda pode fazer isso. O modelo só aparece quando você omite o -m.

Um exemplo de modelo melhor

Você pode personalizar modelos para se adequar ao fluxo de trabalho da sua equipe. Aqui está um exemplo mais detalhado:

# Tipo: [feat|fix|docs|refactor|test|chore]
# Escopo: (nome do módulo ou arquivo opcional)
# Assunto: (descrição imperativa curta)

# Corpo:
# - Motivação e contexto
# - Link para problemas ou tickets relacionados

# Rodapé:
# - Mudanças que quebram compatibilidade
# - Discussões relacionadas

Esta abordagem corresponde aos padrões comuns de Conventional Commits.

Por que usar um modelo de commit Git

• Consistência: Seu histórico será muito mais fácil de ler.
• Velocidade: Não é necessário pensar sobre o formato toda vez.
• Melhores revisões de código: Commits claros agilizam a revisão por pares.
• Depuração mais fácil: Você pode rastrear bugs e mudanças com mais eficiência.

Relacionado: Como criar e usar aliases Git para um fluxo de trabalho mais rápido

Conclusão

Um modelo de commit Git é uma ferramenta simples, mas poderosa para melhorar a qualidade do código e a colaboração da equipe. Ao dedicar alguns minutos para configurar um, você economizará tempo, reduzirá a confusão e escreverá melhores commits desde o primeiro dia.

Perguntas Frequentes