A regra do imperativo
A mensagem completa a frase If applied, this commit will...: ...add login screen, ...fix null pointer in checkout. Por isso o verbo vai no imperativo e sem ponto final. O título deve caber em cerca de 50 caracteres e, se precisar de mais, uma linha em branco separa o corpo.
Verbos mais usados
| Verbo | Quando usar | Exemplo |
|---|---|---|
| Add | algo novo | Add search filters |
| Fix | correção de bug | Fix crash on empty cart |
| Update | mudança em algo existente | Update README setup steps |
| Remove | apagar | Remove unused imports |
| Refactor | reorganizar sem mudar comportamento | Refactor payment service |
| Rename | renomear | Rename user_id to account_id |
| Bump | subir versão de dependência | Bump axios to 1.7.2 |
| Revert | desfazer commit | Revert "Add search filters" |
| Improve | melhoria | Improve error messages |
| Move | mudar de lugar | Move helpers to utils |
Conventional Commits
Muitos times usam o padrão type: description: feat: (funcionalidade), fix: (correção), docs:, refactor:, test:, chore: (manutenção). Exemplos:
| Commit | O que diz |
|---|---|
| feat: add dark mode toggle | nova funcionalidade: botão de modo escuro |
| fix: handle empty response from API | correção: tratar resposta vazia da API |
| docs: update install instructions | documentação: atualizar instruções de instalação |
| refactor: extract date helpers | refatoração: extrair funções de data |
| test: add unit tests for parser | testes: adicionar testes do parser |
| chore: bump dependencies | manutenção: atualizar dependências |
Erros comuns de brasileiro
| Evite | Prefira | Por quê |
|---|---|---|
| Added login | Add login screen | imperativo e mais específico |
| Fixing bug | Fix crash when cart is empty | diga qual bug |
| Changes | Update API timeout to 30s | mensagem genérica não ajuda ninguém |
| Correction of the error in the payment | Fix payment rounding error | curto e direto |
Commit em inglês ou português? Se o time ou o projeto é internacional, ou o código é aberto, em inglês. Mais frases para PR em pull request em inglês.
Como treinar estas frases
Escolha três frases, adapte ao seu caso e fale em voz alta antes da próxima reunião. O Devlingo, do Gambit Studio, tem mais de 3.600 frases de trabalho em tecnologia, separadas por situação, com 10 frases novas por dia, pronúncia e exemplos de uso, e um widget com a frase do dia na Tela de Início.