Boas práticas de mensagens de commit
2020-03-20
Esse post é um acompanhamento da minha apresentação no Focatalks #2. Siga para a leitura adicional para entender o porquê de se seguir essas boas práticas.
O verdadeiro commando ✅
Para escrever boas mensagens use git commit, sem o -m, para abrir o editor padrão. Desse jeito, você se força a parar um pouco e pensar na sua mensagem de commit. Além disso, os editores modernos te ajudam a manter as boas práticas, te indicando quando há muitos caracteres e pulando linhas automaticamente.
Se o editor que o comando git commit abre não é o seu preferido, é só usar a configuração do git pra mudar:
git config --global core.editor "nano -w"
Anatomia de uma mensagem 🦴
Resumo curto que descreve o commit
Descrição mais detalhada do que o commit faz.
Explicação do "porque" das mudanças sendo feitas.
Um rodapé com referências.
O resumo 🤏
Descrição consisa do que o commit faz
Regras 📜
- Limite o resumo a 50 caracteres
- Inicie com letra maiúscula e termine sem pontuação
- Escreva no imperativo
Dicas
- Seu resumo deve encaixar na frase
Se esse commit for aplicado ele ...
- Especifique o tipo do commit com uma palavra ou um emoji
bug: Corrige banner aparecendo duas vezes
🌈 Aumenta margem no grid de usuários
O Corpo 🧍
Explica o quê e o porquê
Regras 📜
- Deixe uma linha em branco entre o resumo e o corpo
- Limite as linhas a 72 caracteres
- Não explique o como. Quem deve fazer isso é o código
O Footer
Referências, issue tracker, pr, etc