- Motivos para escrever boas mensagens de commit
- Mensagens de commit consistentes e claras ajudam outros desenvolvedores a entender com mais facilidade
- Usar boas mensagens de commit facilita a depuração de problemas no código
- Mensagens de commit bem elaboradas transmitem o contexto das mudanças para outros desenvolvedores que trabalham no projeto e para você mesmo no futuro
- Como escrever boas mensagens de commit
- Indique no início o tipo de commit, mostrando que tipo de conteúdo ele traz
- Escreva a mensagem de commit de forma detalhada por consideração aos outros (usando o commit body)
- Use um tom de comando ou solicitação na mensagem de commit
- Remova pontuação desnecessária
- Siga a 'convenção de commits' definida pela equipe
- Convenção de commits da equipe de produto da Infograb
- Adicionam emojis para cada tipo de commit, facilitando a visualização rápida
- Para diferenciar componentes, páginas e funções, componentes são escritos com inicial maiúscula, enquanto páginas e funções são escritas em minúsculas
- Usam o commit body para adicionar detalhes ao commit
- Para manter a mensagem de commit concisa, abreviam a palavra ‘function’ para ‘função’
2 comentários
É bem difícil concordar com a parte de que emojis melhoram a legibilidade. Se fossem só 3, até vai...
Este artigo também é bom.
https://chris.beams.io/posts/git-commit/
https://item4.github.io/2016-11-01/How-to-Write-a-Git-Commit-Message/