A mensagem é composta pelo "tipo + descrição" e deve seguir o seguinte formato:
<tipo>: <descrição>
Regras:
- A mensagem (tipo + ": " + descrição) deve possuir no máximo 72 caracteres
- A mensagem deve ser escrita em inglês para manter a consistência e evitar a mistura de idiomas. Exemplo de mensagem incorreta:
feat: adicionar autenticação de usuário - O tipo deve conter apenas caracteres minúsculos
- Os tipos permitidos estão descritos na Tabela 1
- A descrição deve ser em linguagem imperativa. Ex.: add user authentication e não added ou adding
- A descrição deve ser clara e objetiva, respondendo à pergunta: “O que esse commit faz?” ou “O que esse commit adiciona ao sistema?”
- Na descrição use apenas letras minúsculas (exceto em siglas) e não finalize a descrição com ponto final
| Tipo | Descrição |
|---|---|
| feat | Adição de nova funcionalidade |
| fix | Correção de erro (bug fix) |
| 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 ou dependências externas |
| ci | Alterações em arquivos e scripts de configuração de CI |
| docs | Alterações apenas na documentação |
Todas as regras anteriores são aplicáveis aqui (com exceção da regra 4). Os tipos permitidos estão descritos na Tabela 2. A mensagem deve seguir o seguinte formato:
<tipo>(test): <descrição>
| Tipo | Descrição |
|---|---|
| feat | Adição de novo teste para uma funcionalidade |
| fix | Correção em um teste existente |
| refactor | Refatoração de código de teste |
A mensagem de commit inicial deve ser estritamente esta:
initial commit