Padrões de mensagens de commit

Aprenda neste artigo algumas convenções/padronizações das mensagens de commits para o Git/Github.

Padronização de Commits

Formato:

<tipo>(escopo): Assunto
<corpo>
Tipo

• feat: Nova funcionalidade;

• fix : Correção de um bug;

• refactor: Alterações em geral;

• style: Estilização e layout;

• docs: Algo relacionado a documentação;

• perf: Melhorias de performance;

• chore: Build, configs, deploy e afins;

• test: Adicionar ou corrigir testes;

Escopo

• adm: FreedomNEO - ADM

• app: FreedomNEO - APP Portaria

• frq: FreedomNEO - Franqueados

• www: FreedomNEO - Landing-page

Assunto

• Máximo de 50 caracteres

• Assunto deve estar no imperativo

Corpo

• Opcional

• Deve conter o o que e o por que ao invés de conter o como foi feito

• Se for necessário contextualizar o commit ou explicar o porquê das mudanças, fique a vontade!

Exemplo de Commit:

refactor(app): Bloqueia edição da placa do veículo
Inclui trava para o usuário não conseguir editar a placa do veículo

Referências

• Essa padronização das mensagens tem como base o Karma Commit