O que é uma mensagem de commit bem feita? Como deve ser escrita?
As mensagens dos commits devem servir para:
- Ajudar os futuros mantenedores (que pode ser você mesmo) a descobrir porque uma mudança foi feita no código ou porque uma funcionalidade foi adicionada.
- Acelerar o processo de revisão.
- Ajudar a escrever uma boa nota de lançamento.
Escreva sua mensagem de commit desta forma:
Resuma claramente o commit em uma linha, em até 72 caracteres
Abaixo, descreva o problema que o commit resolve ou o caso de uso que
levou à nova funcionalidade. Justifique porque você escolheu essa
solução.
Não descreva o código. Descreva o propósito e a abordagem utilizada.
FAÇA
- Escreva a linha de resumo e a descrição de modo imperativo, como se estivesse comandando alguém. Escreva: "adiciona", "remove", "atualiza" ao invés de "adicionado", "removido", "atualizado".
- O resumo deve ser apenas uma frase e deve começar com uma letra maiúscula.
- Sempre deixe em branco a segunda linha.
- Quebre as linhas da descrição do commit por volta de 72 caracteres, para que não fiquem muito extensas. (Para tornar a mensagem legível sem rolagem horizontal).
NÃO FAÇA
- Não termine a linha de resumo com pontuação e não exceda 80 caracteres.
DICAS
- Se parece difícil resumir o que o seu commit faz, o motivo talvez seja diversas alterações lógicas ou correções de erros. Nesse caso, deve ser dividido em vários commits menores.
REFERÊNCIAS
- On commit messages: http://who-t.blogspot.com/2009/12/on-commit-messages.html
- GNOME - Guidelines for Commit Messages: http://live.gnome.org/Git/CommitMessages
- ScummVM - Commit Guidelines: http://wiki.scummvm.org/index.php/Commit_Guidelines