Padrões e Tipos de Commits
Aqui utilizamos uma padronização das mensagens de commits baseado no padrão do Conventional Commits.
Padrão
As mensagens seguem o seguinte padrão:
<tipo>(escopo-opcional): <descrição-do-commit>
Exemplo:
feat(Carrossel): Criação da estrutura inicial do Carrossel
fix(Carrossel): Bug do Carrossel não passando imagens
Tipos
Os principais tipos usados são:
- feat - descreve a adição de uma nova funcionalidade à base de código
- fix - descreve a correção de um problema ou bug existente na base de código
- chore - descreve tarefas “obrigatórias”, que não possuem um intuito de funcionalidade novas
- refactor - descreve a refatoração, limpeza de código ou renomeação de funções e variáveis
- docs - descreve a alteração ou criação de novas documentações na base de código ou em documentos como README
- test - descreve alterações em testes automatizados ou em testes de integração
- merge - descreve alterações de integração de código (deve ser usado com pouca frequência)
Escopo
Descreve o contexto em que a mudança está sendo realizada, por exemplo, qual funcionalidade ou qual a página.
Descrição
A descrição deve ser sucinta, não passando mais de 15 palavras e explicando a alto nível o que foi alterado.