Skip to content

Instantly share code, notes, and snippets.

@mtfrsantos
Last active March 4, 2026 20:40
Show Gist options
  • Select an option

  • Save mtfrsantos/e08e3de7b50125ba9226e851e38137bc to your computer and use it in GitHub Desktop.

Select an option

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
fix Correção de um erro (bug)
refactor Alterações de código que não corrigem erros nem adicionam funcionalidades, incluindo melhorias de desempenho e ajustes de estilização
build Mudanças que afetam o build do sistema, dependências externas ou configurações e scripts de CI (ex: npm, Docker, GitHub Actions)
docs Alterações apenas na documentação
revert Reverter um commit anterior. Na mensagem deve constar: "commit <hash>", onde o hash é o SHA do commit original. Ex.: revert: commit e08e3de7b50125ba9226e851e38137bc

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
fix Correção de um erro (bug)
refactor Alterações de código que não corrigem erros nem adicionam funcionalidades, incluindo melhorias de desempenho e ajustes de estilização

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