Padrões de Commit

O que são Padrões de Commit?

Os Padrões de Commit são convenções utilizadas na escrita de mensagens de commit em repositórios de controle de versão, como o Git. Essas convenções ajudam a manter um histórico de código limpo, compreensível e consistente ao longo do tempo. Esses commits auxiliarão a equipe a entender de forma facilitada quais alterações foram realizadas no trecho de código que foi commitado.

Por que Usar Padrões de Commit?

• Histórico Claro: Mensagens de commit bem escritas fornecem um histórico claro das alterações realizadas ao longo do tempo. Isso facilita a revisão de código e a compreensão das mudanças que foram feitas em um determinado período de tempo.
• Facilita a Revisão de Código: Uma história de commit coesa facilita a revisão de código por membros da equipe. Isso permite que os desenvolvedores entendam rapidamente as mudanças que foram feitas e por que elas foram feitas.

Tipos Comuns de Padrões:

1. feat: Nova funcionalidade ou aprimoramento significativo.
2. fix: Correção de bug.
3. chore: Tarefas de manutenção, refatoração ou outras atividades que não afetam diretamente o usuário final.
4. docs: Alterações na documentação.
5. style: Atualizações que não afetam o código (formatação, ponto e vírgula ausente, etc.).
6. test: Adição ou modificação de testes.

Como Escrever Boas Mensagens de Commit

Uma mensagem de commit bem escrita pode tornar muito mais fácil para outros desenvolvedores entenderem o que foi alterado e por que essas alterações foram feitas.

• Utilize um resumo claro: A primeira linha da mensagem de commit deve ser uma breve descrição das alterações que foram feitas. Geralmente, isso é conhecido como o "resumo" ou "header" do commit. Deve ser conciso e direto ao ponto. Deve ser no máximo 50 caracteres de comprimento.

• Explique as alterações: Se necessário, você pode fornecer uma descrição mais detalhada após o resumo. Esta descrição deve explicar o que foi alterado e por que essas alterações foram feitas.

• Use o imperativo: Cada mensagem de commit deve ser clara e concisa. Comece com um verbo no imperativo ("Adiciona", "Corrige", "Atualiza", etc.). Isso torna as mensagens de commit mais fáceis de ler e entender.

• Consistência: Mantenha a consistência ao longo do projeto. Todos os membros da equipe devem seguir os mesmos padrões.

Exemplo Prático:

git commit -m "feat(login): add login functionality"
git commit -m "fix(register): fix register button styling"
git commit -m "docs(readme): update readme with installation instructions"
git commit -m "style(buttons): adjust button padding"
git commit -m "refactor(auth): simplify authentication logic"
git commit -m "test(login): add login test cases"
git commit -m "chore(package): update package version"