1.6 KiB
1.6 KiB
| title | localeTitle |
|---|---|
| Writing Good Git Commit Messages | Escrevendo boas mensagens de commit do Git |
- Assunto separado do corpo com uma linha em branco
- Limite a linha de assunto para 50 caracteres
- Capitalize a linha de assunto
- Não termine a linha de assunto com um período
- Use o humor imperativo na linha de assunto
- Enrole o corpo em 72 caracteres
- Use o corpo para explicar o que e porque vs. como
Uma linha de assunto commit commit formada corretamente deve sempre poder completar a seguinte frase:
Se aplicado, este commit será
<<your subject line here>>
Por exemplo:
- Se aplicado, este commit irá Refatorar o subsistema X para legibilidade
- Se aplicado, este commit atualizará a documentação inicial
- Se aplicado, essa confirmação removerá os métodos reprovados
- Se aplicado, este commit lançará a versão 1.0.0
- Se aplicado, essa confirmação mesclará solicitação de solicitação # 123 do usuário / filial
Observe como isso não funciona para as outras formas não imperativas:
- Se aplicado, este commit corrigirá um bug com Y
- Se aplicado, este commit mudará o comportamento de X
- Se aplicado, este commit vai mais correções para coisas quebradas
- Se aplicado, esse commit vai adotar novos métodos de API
Lembre-se: O uso do imperativo é importante apenas na linha de assunto. Você pode relaxar essa restrição quando estiver escrevendo o corpo.
Referência: http://chris.beams.io/posts/git-commit