Os "Conventional Commits" (Compromissos Convencionais) são um conjunto de convenções para criar mensagens de commit padronizadas em projetos de desenvolvimento de software. Essas convenções foram introduzidas para facilitar a automação do processo de geração de changelogs, versionamento semântico e comunicação eficiente sobre as alterações realizadas no código.
As mensagens de commit no estilo Conventional Commits seguem um formato específico, que inclui um tipo, um escopo opcional e uma mensagem.
-
Tipos de Commit:
feat: Adiciona uma nova funcionalidade ao código.fix: Corrige um bug no código.docs: Atualizações ou adições à documentação.style: Ajustes relacionados à formatação e estilos de código.refactor: Refatoração do código, sem alteração funcional.test: Adiciona ou modifica testes.chore: Tarefas de manutenção, configuração ou outras atividades não relacionadas diretamente ao código do aplicativo.
-
Formato da Mensagem de Commit:
<tipo>[escopo]: <mensagem>- Exemplo:
feat[login]: adiciona a funcionalidade de login
-
Regras Adicionais:
- Mantenha as mensagens de commit curtas e descritivas.
- Use o imperativo na mensagem ("adiciona", "corrige", "atualiza" em vez de "adicionando", "corrigindo", "atualizando").
- Adicione um escopo opcional entre parênteses, indicando a área ou componente afetado pela alteração.
-
Exemplos de Mensagens de Commit:
feat[login]: implementa autenticação de usuáriofix[button]: resolve problema de sobreposição no botãodocs[readme]: atualiza instruções de instalação
Ao seguir essas regras, você pode criar mensagens de commit claras e consistentes, facilitando a leitura do histórico do Git, gerando changelogs automáticos e colaborando eficientemente com outros membros da equipe.