Escrever commits claros e organizados é essencial para manter a evolução do sistema compreensível. Um commit bem escrito facilita revisões, depurações, documentação e colaboração em equipe.

✨ 1. Clareza nas mensagens

Cada commit deve dizer exatamente o que foi alterado — e não apenas o que você “queria fazer”.

❌ ruim

arruma coisas

✔️ bom

corrige erro ao atualizar endereço do usuário

✍️ 2. Use verbos no imperativo

O imperativo mantém padronização e facilita leitura.

Prefira:

corrige
adiciona
remove
melhora
atualiza

Evite:

corrigido
adicionando
removido

🧩 3. Commit pequeno

Cada commit deve conter uma única mudança (ou pelo menos uma única ideia lógica).

Isso ajuda:

rollback
pull request
code review
histórico limpo

📦 4. Utilize Conventional Commits

Padrão recomendado para classificar tipo de mudança:

feat     // nova funcionalidade
fix      // correção de bug
docs     // apenas documentação
refactor // mudança na lógica sem alterar comportamento
test     // testes automatizados
style    // formatação ou lint
perf     // melhoria de performance
chore    // tarefas internas do projeto
ci       // CI/CD

Exemplo:

feat: adiciona filtros no catálogo

🧾 5. Formato simples e padronizado

Recomendação:

tipo: descrição curta

Exemplos:

fix: corrige validação de email
refactor: melhora estrutura do service
docs: adiciona exemplo no README

🔍 6. Explique o porquê quando necessário

Se for preciso incluir detalhamento, coloque no corpo do commit:

fix: corrige erro no cálculo de preços

O problema acontecia porque o valor retornado do ERP já vinha convertido,
então era somado duas vezes.

Isso ajuda muito alguém no futuro.

🪓 7. Evite mensagens vagas

Mensagens que não dizem nada atrapalham todo o time.

Evite:

ajustes finais
pequenos updates
arrumando
testando

📅 8. Não coloque datas

Datas mudam, mensagens ficam inúteis.

O Git já guarda data automaticamente.

📚 9. Não coloque nome de pessoa

Evite coisas tipo:

commit do fulano
feito por mim

O Git já registra o autor.

🧠 10. Pense como histórico, não como tarefa

Commits contam uma história técnica evolutiva.

A mensagem deve fazer sentido mesmo daqui a 1 ano, fora do contexto atual.

✔ Resumo do padrão recomendado

feat: adiciona módulo de relatórios
fix: corrige erro no cálculo de juros
refactor: otimiza função de importação
docs: documenta endpoints de vendas
perf: melhora tempo de consulta
test: adiciona teste unitário de login

Boa Sorte! 😊