Padrão 'Conventional Commits': Escreva commits de forma clara e organizada
- #GitHub
- #Git
"Conventional Commits" é um padrão de escrita de mensagens de commit em projetos de desenvolvimento de software, que segue uma convenção específica para que as mensagens de commit sejam mais claras e informativas. Essa convenção geralmente inclui um formato que descreve o tipo da alteração, o escopo da alteração e uma breve descrição da alteração.
Os tipos comuns incluem:
- feat: Para adicionar uma nova funcionalidade. Exemplo:
feat: Adiciona um formulário de login
. - fix: Para corrigir um bug. Exemplo:
fix: Resolve o problema de autenticação
. - docs: Para atualizar documentação. Exemplo:
docs: Atualiza o README com instruções claras
. - style: Para ajustar formatação, espaçamento, etc., que não afetam o comportamento do código. Exemplo:
style: Corrige a formatação do código
. - refactor: Para reorganizar o código existente sem adicionar ou remover funcionalidades. Exemplo:
refactor: Reestrutura a classe de autenticação
. - chore: Para tarefas de manutenção, como atualização de dependências. Exemplo:
chore: Atualiza biblioteca de terceiros
. - test: Para adicionar ou modificar testes. Exemplo:
test: Adiciona testes de unidade para o serviço de usuário
.
O "Conventional Commits" é útil porque tornam mais fácil entender o que foi feito em cada commit, ajudando na colaboração entre desenvolvedores e na automação de tarefas, como a geração de changelogs.
Em resumo, eles ajudam a manter um histórico de commits mais organizado e informativo.
Maiores informações: Conventional Commits