Veja como pequenas alterações nas mensagens de commit no Git podem ajudar você e seu time a melhorar a legibilidade e rastreabilidade do seu código.
Formato:
<tipo>[escopo opcional]: <descrição>
[corpo opcional]
[rodapé opcional]
rodapé é opcional, mas eu recomendo quando estiver usando Jira, porque o Jira consegue rastrear e relacionar Jira Issues com commit, branch e pull request, desde que você esteja usando a chave do Jira Issue como footer.
fix: correct minor typos in code
see the issue for details
on typos fixed.
JIRAISSUEKEY-123
Co-authored-by: Fulana Silva <[email protected]>
Co-authored-by: Beltrano Costa <[email protected]>
Outra convenção importante é inserir tipos no título do commit, seja alguns tipos e seus respectivos propósitos:
feat: (nova funcionalidade para o usuário, não use quando a funcionalidade não tiver relação com o usuário, por exemplo, criar um script de build)fix: (corrigir um bug para o usuário, não usar para correção de bugs que não aferam o usuário)docs: (alterações em documentações)style: (formatação, lint, esqueçeu um ponto de vírgula, etc; sem alteração de código de produção)refactor: (refatoração de código de produção, por exemplo, renomear uma variável)test: (adicionar testes, refatorar testes; sem alteração de código de produção)chore: (atualização de tarefas de rotina; sem alteração de código de produção)
Saiba mais em: