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 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 |
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 adicionada no projeto |
| refactor | Refatoração de alguma parte do código |
| fix | Correção de erros (bugs) |
A mensagem de commit inicial deverá ser estritamente essa:
initial commit
Formato 3: Mensagem de commit inicial.