Conventional Commits

[layla-ventilari]

Os Conventional Commits são um conjunto de regras simples para a criação de mensagens de commit. Essas regras permitem que as mensagens de commit sejam lidas automaticamente por ferramentas, facilitando o processo de geração de changelogs e análise de alterações no código.

Regras dos Conventional Commits

As regras básicas dos Conventional Commits são:

• Cada mensagem de commit deve ser estruturada em três partes separadas por um espaço: tipo, escopo e descrição. Exemplo: "feat(login): adiciona validação de senha".
• O tipo indica o propósito do commit e pode ser:
  • feat: para novas funcionalidades;
  • fix: para correção de bugs;
  • refactor: para refatoração de código;
  • docs: para alterações em documentação;
  • test: para adição ou alteração de testes;
  • style: para alterações em estilos (CSS, por exemplo);
  • chore: para alterações em tarefas auxiliares (por exemplo, atualização de dependências).
• O escopo é opcional e indica qual parte do código foi alterada.
• A descrição deve ser clara e concisa.

Exemplo de mensagem de commit

feat(login): adiciona validação de senha

• feat: novo recurso adicionado
• (login): alteração relacionada ao login
• adiciona validação de senha: descrição clara e concisa do que foi adicionado

Vantagens dos Conventional Commits

Usar os Conventional Commits traz várias vantagens, como:

• Mensagens de commit mais claras e concisas;
• Geração automatizada de changelogs;
• Análise mais fácil de alterações no código;
• Facilidade na criação de scripts e ferramentas de automação para trabalhar com commits.