A convenção de commits é um conjunto de regras para criar mensagens de commit mais claras e informativas. Seguir essa convenção ajuda a manter um histórico de commits organizado e facilita a compreensão das alterações no projeto.
A estrutura básica de uma mensagem de commit é:
<tipo>: <descrição>
[Corpo opcional]
[Footer opcional (para referenciar issues ou breaking changes)]
tipo: Identifica a categoria da alteração.descrição: Resumo curto e objetivo sobre a modificação.corpo(opcional): Explicação detalhada da alteração.footer(opcional): Utilizado para referenciar issues ou indicar mudanças significativas.
| Tipo | Descrição | Exemplo |
|---|---|---|
feat |
Adiciona uma nova funcionalidade ao projeto. | feat: adiciona botão de login |
fix |
Corrige um bug. | fix: corrige erro no carregamento |
docs |
Alterações na documentação. | docs: atualiza README |
style |
Ajustes de formatação e estilo, sem alterar o funcionamento. | style: ajusta indentacão |
refactor |
Refatoração de código sem mudar comportamento. | refactor: melhora performance da API |
test |
Adiciona ou modifica testes. | test: adiciona testes unitários |
chore |
Tarefas de suporte, como atualização de dependências. | chore: atualiza versão do eslint |
perf |
Melhoria de desempenho. | perf: otimiza algoritmo de busca |
build |
Mudanças que afetam o sistema de build ou dependências externas. | build: configura webpack |
ci |
Ajustes em configurações de integração contínua. | ci: adiciona workflow de testes |
- Adicionando uma nova funcionalidade:
feat: adiciona funcionalidade de compartilhamento nas redes sociais- Corrigindo um bug:
fix: corrige erro no envio de formulário- Atualizando documentação:
docs: atualiza documentação da API- Melhorando a performance:
perf: otimiza algoritmo de busca em grandes bases de dados- Adicionando testes:
test: adiciona testes unitários para LoginService- Seja descritivo: Forneça uma descrição clara e objetiva da alteração realizada.
- Use o tempo imperativo: Como se estivesse dando uma instrução. Ex:
adicionar,corrigir,ajustar. - Evite commits grandes: Divida alterações em pequenos commits sempre que possível.
- Adicione contexto: Quando relevante, inclua detalhes adicionais no corpo do commit.
- Conventional Commits
- Angular Commit Guidelines
- GitHub Docs - Criar commits
- Keep a Changelog
- Git Commit Message Guidelines
Seguir uma convenção de commits ajuda toda a equipe a entender rapidamente as mudanças no código e melhora a gestão do projeto. 🚀