Este documento define o padrão de mensagens de commit utilizado nos meus projetos.
–
| Tipo | Quando usar | Exemplo |
|---|---|---|
| feat | Nova funcionalidade | feat: adiciona menu hambúrguer |
| fix | Correção de bug | fix: corrige erro no botão do menu |
| refactor | Reorganização do código sem alterar comportamento | refactor: reorganiza script do menu |
| style | Alterações visuais ou de formatação | style: ajusta indentação do CSS |
| docs | Alterações na documentação | docs: adiciona guia de commits |
| chore | Tarefas de manutenção | chore: reorganiza estrutura do projeto |
| test | Adição ou modificação de testes automatizados | test: adiciona testes do formulário |
–
Os commits seguem a seguinte estrutura:
tipo: descrição curta do que foi feito
Exemplo:
feat: adiciona menu hambúrguer responsivo
fix: corrige erro na navegação mobile
refactor: melhora organização do código do header
featUsado quando uma nova funcionalidade é adicionada.
Exemplo:
feat: adiciona menu hambúrguer para telas mobile
fixUsado para correção de bugs ou problemas.
Exemplo:
fix: corrige comportamento do botão de menu em telas pequenas
refactorUsado quando o código é reorganizado ou melhorado sem alterar comportamento.
Exemplo:
refactor: reorganiza funções do menu em módulo separado
styleMudanças que afetam apenas estilo ou formatação do código.
Exemplo:
style: ajusta indentação do CSS
Usado quando apenas documentação é alterada.
Exemplo:
docs: adiciona explicação sobre acessibilidade do menu
choreTarefas de manutenção do projeto.
Exemplo:
chore: atualiza estrutura de pastas
testUsado quando são adicionados, modificados ou corrigidos testes automatizados do projeto.
Esse tipo de commit indica mudanças relacionadas apenas à verificação do funcionamento do código, sem alterar a lógica principal da aplicação.
Exemplo:
test: adiciona testes para validação do formulário
test: corrige teste que falhava no menu mobile
Boas práticas:
Cada commit deve representar uma mudança clara e específica.
Boas práticas: