Começando
Aprenda nossa convenção de commit
2 min read
•284 wordsGostamos de ter um histórico de projeto limpo. Nossa convenção de commits é inspirada por Conventional Commits mas personalizada com gitmoji para torná-la mais visual e divertida.
Estrutura
A mensagem de commit deve ser estruturada da seguinte forma e em letras minúsculas:
<gitmoji> <tipo> <descrição> [(#<número do problema>)]
[cuerpo opcional]
[rodapé(s) opcional(is)]
Exemplo
📝 atualizar colaboradores da documentação
- Adicionar @jerembdn como colaborador
- Adicionar @younesbessa como colaborador
Co-authored-by: Younes Bessa <[email protected]>
Na maioria das vezes, uma linha simples é suficiente:
📝 atualizar colaboradores da documentação
Tipos
Usamos os seguintes tipos de commit:
| Tipo | Descrição |
|---|---|
add | Adicionar uma nova funcionalidade |
fix | Corrigir um bug |
improve | Melhorar algo |
update | Atualizar algo |
remove | Remover algo |
refactor | Refatorar algo |
rename | Renomear algo |
move | Mover um arquivo ou pasta |
upgrade | Atualizar dependências |
downgrade | Retornar dependências |
Descrição
Escreva descrições no modo imperativo e em letras minúsculas:
# Bom
📝 atualizar colaboradores da documentação
# Ruim
📝 atualizou colaboradores da documentação
# Ruim
📝 Atualizar colaboradores da documentação
Número do Problema
Linke commits a problemas adicionando o número do problema:
📝 atualizar colaboradores da documentação (#123)
Corpo
Use o corpo para contexto e motivação:
📝 atualizar colaboradores da documentação
- Adicionar @jerembdn como colaborador
- Adicionar @younesbessa como colaborador
Co-authored-by: Younes Bessa <[email protected]>
Um Commit, Um Propósito
Cada commit deve representar uma única alteração lógica. Não misture alterações não relacionadas.
Last updated on 01/14/2026