Skip to content

Instantly share code, notes, and snippets.

@renatoapcosta
Last active November 27, 2022 22:24
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save renatoapcosta/d14f2d6a99c75fa5501a7582196de8fc to your computer and use it in GitHub Desktop.
Save renatoapcosta/d14f2d6a99c75fa5501a7582196de8fc to your computer and use it in GitHub Desktop.
Convenção de commits

Convenção de commits

<type>[optional scope]: <description>

Onde type:

feat - introduz um novo recurso
fix - corrige um bug em sua base de código
chore -  indica mudanças no projeto que não afeta o sistema ou arquivos de testes. São mudanças de desenvolvimento sem alteração do código de produção
refactor - refatorando o código de produção, por exemplo, renomeando uma variável
test - adicionando testes ausentes, testes de refatoração; nenhuma alteração no código de produção
build - usado para indicar mudanças que executaram o processo de construção do projeto ou dependências externas.
ci -  utilizado para mudanças nos arquivos de configuração de CI
docs - alterações na documentação
style - formatação, falta de ponto e vírgula, etc; nenhuma alteração no código de produção
perf - indica uma alteração que melhorou a performance do sistema.
revert - indica a reverão de um commit anterior.

Exemplo

git commit -m "chore: add npm"

As palavras-chaves “DEVE” (“MUST”), “NÃO DEVE” (“MUST NOT”), “OBRIGATÓRIO” (“REQUIRED”), “DEVERÁ” (“SHALL”), “NÃO DEVERÁ” (“SHALL NOT”), “PODEM” (“SHOULD”), “NÃO PODEM” (“SHOULD NOT”), “RECOMENDADO” (“RECOMMENDED”), “PODE” (“MAY”) e “OPCIONAL” (“OPTIONAL”), nesse documento, devem ser interpretados como descrito na RFC 2119.

Não use verbo no passado!!

Messagens exemplo

message-commit

Links

Conventional Commits

semantic_commit_messages

conventional-commits-pattern

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment