Mensagens de commit
Justificativa
Uma mensagem de commit documenta e explica o motivo de uma alteração no código-fonte, funcionando como um "diário de bordo do desenvolvimento". Suas principais funções são:
- explicar o porquê das alterações;
- facilitar o trabalho em equipe;
- gerar histórico e documentação.
Conforme o Relatório de inconsistências: Gerência de Configuração de Software, não seguir um padrão de mensagens causa perda de rastreabilidade e reduz a eficiência da revisão de código.
Para resolver isso foi escolhido o Conventional Commits, padrão mais utilizado na indústria e mais completo, complementar ao SemVer (Versionamento Semântico).
Estrutura padrão
Segundo a documentação do Conventional Commits:
<tipo>[escopo opcional]: <descrição>
[corpo opcional]
[rodapés opcionais]
Exemplo:
feat: adiciona filtro de jogos por mando de campo
Tags de tipo
O Conventional Commits define dois tipos principais (feat e fix) e alguns adicionais. Para o escopo atual dos projetos foram selecionados os seguintes:
| Tag | Objetivo |
|---|---|
| feat | O código alterado inclui um novo recurso |
| fix | O código alterado soluciona um problema |
| docs | Houve mudanças na documentação |
| tests | Houve alterações nos testes (criação, edição ou exclusão) |