Skip to content

Instantly share code, notes, and snippets.

@mtfrsantos
Last active July 18, 2023 12:39
Show Gist options
  • Save mtfrsantos/e08e3de7b50125ba9226e851e38137bc to your computer and use it in GitHub Desktop.
Save mtfrsantos/e08e3de7b50125ba9226e851e38137bc to your computer and use it in GitHub Desktop.
Padronização de mensagens de commits

Padronização de mensagens de commits

1. Mensagem de commit padrão

A mensagem de commit padrão deve seguir o seguinte formato:

foo: bar qux baz

Formato 1: Mensagem de commit padrão.

Sendo que,

  • foo deve ter todos os caracteres minúsculos e descrever o tipo do commit baseado na Tabela 1;
  • bar qux bax é a mensagem detalhada sobre as modificações. Deve também ter todos os caracteres minúsculos (salvo siglas) e ser escrita preferencialmente em inglês.

Tabela 1: Tipos de commit padrão

Tipo Descrição
feat Nova funcionalidade adicionada no projeto
refactor Refatoração de alguma parte do código
fix Correção de erros (bugs)
chore Alteração na documentação do projeto ou quaisquer mudanças que não influenciam no código principal. Exemplo: readme, swagger, .gitignore, eslint, etc
build Mudanças que impactam no processo de build ou nas configurações do CI

2. Mensagem de commit relacionado a testes

Quando houver modificações nos testes, a mensagem de commit deve ser da seguinte forma:

foo[test]: bar qux baz

Formato 2: Mensagem de commit quando houver modificações nos testes.

Sendo que,

  • foo deve ter todos os caracteres minúsculos e descrever o tipo do commit baseado na Tabela 2;
  • bar qux bax é a mensagem detalhada sobre as modificações. Deve também ter todos os caracteres minúsculos (salvo siglas) e ser escrita preferencialmente em inglês.

Tabela 2: Tipos de commit relacionado a testes

Tipo Descrição
feat Nova funcionalidade adicionada no projeto
refactor Refatoração de alguma parte do código
fix Correção de erros (bugs)

3. Mensagem de commit inicial

A mensagem de commit inicial deverá ser estritamente essa:

initial commit

Formato 3: Mensagem de commit inicial.

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