A mensagem de commit padrão deve seguir o seguinte formato:
foo: bar qux baz
Formato 1: Mensagem de commit padrão.
Sendo que,
foodeve 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.
| 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 |
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,
foodeve 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.
| 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 |
A mensagem de commit inicial deverá ser estritamente essa:
initial commit
Formato 3: Mensagem de commit inicial.