De acordo com a documentação do Conventional Commits A especificação de Commits Convencionais é uma convenção simples em cima das mensagens de confirmação. Ele fornece um conjunto fácil de regras para criar um histórico de confirmação explícito; o que torna mais fácil escrever ferramentas automatizadas em cima. Essa convenção se encaixa com o SemVer, descrevendo os recursos, correções e alterações importantes feitas nas mensagens de confirmação.
feat
são quaisquer adições ao código. Enquanto elas podem alterar parte do código já existente, o foco dela é a implementação de features novas ao ecossistema.fix
refere-se às correções de bugs. Caso seu time trabalhe com issues ou com Jira, é possível com smart commits associar seu commit a uma issue e alterar seu estado com keywords como resolve, fix, solves. Em geral, essas marcações devem vir na descrição ou no footer.refactor
refere-se a quaisquer mudanças que atinjam o código, porém não alterem sua funcionalidade. Alterou o formato de como é processamento em determinada parte da sua tela, mas manteve a mesma funcionalidade? Declare como refactor.style
São alterações referentes a formatações de código, semicolons, trailing spaces e lintChore
Utilizado na atualização para mudanças em ferramentas, configurações e bibliotecas. Atualizações que não ocasionam em alteração no código de produção.Doc
Utilizado quando é adicionado ou atualizado alguma documentação no projeto.Test
Utilizado quando feita qualquer alteração em relação aos testes do projeto.
- No titulo resumir em 4 palavras
- Na descrição tentar deixar o mais claro possível oque foi feito no commit
- Nos links, não ultilizar encurtador ou redirecionador
- Usar o emoji corespondente ao commit
Tipo de commit | Emojis |
---|---|
Acessibilidade | ♿ :wheelchair: |
Adicionando um teste | ✅ :white_check_mark: |
Adicionando uma dependência | ➕ :heavy_plus_sign: |
Alterações de revisão de código | 👌 :ok_hand: |
Animações e transições | 💫 :dizzy: |
Bugfix | 🐛 :bug: |
Comentários | 💡 :bulb: |
Commit inicial | 🎉 :tada: |
Configuração | 🔧 :wrench: |
Deploy | 🚀 :rocket: |
Documentação | 📚 :books: |
Em progresso | 🚧 :construction: |
Estilização de interface | 💄 :lipstick: |
Infraestrutura | 🧱 :bricks: |
Lista de ideias (tasks) | 🔜 :soon: |
Mover/Renomear | 🚚 :truck: |
Novo recurso | ✨ :sparkles: |
Package.json em JS | 📦 :package: |
Performance | ⚡ :zap: |
Refatoração | ♻️ :recycle: |
Removendo um arquivo | 🔥 :fire: |
Removendo uma dependência | ➖ :heavy_minus_sign: |
Responsividade | 📱 :iphone: |
Revertendo mudanças | 💥 :boom: |
Segurança | 🔒️ :lock: |
SEO | 🔍️ :mag: |
Tag de versão | 🔖 :bookmark: |
Teste de aprovação | ✔️ :heavy_check_mark: |
Testes | 🧪 :test_tube: |
Texto | 📝 :pencil: |
Tipagem | 🏷️ :label: |
Tratamento de erros | 🥅 :goal_net: |
Comando git | Resultado no GitHub |
---|---|
git commit -m ":tada: Commit inicial"
|
🎉 Commit inicial |
git commit -m ":books: docs: Atualizaçao do README"
|
📚 docs: Atualizaçao do README |
git commit -m ":bug: fix: Loop infinito na linha 50"
|
🐛 fix: Loop infinito na linha 50 |
git commit -m ":sparkles: feat: Pagina de login"
|
✨ feat: Pagina de login |
git commit -m ":bricks: ci: Modificaçao no Dockerfile"
|
🧱 ci: Modificaçao no Dockerfile |
git commit -m ":recycle: refactor: Passando para arrow functions"
|
♻️ refactor: Passando para arrow functions |
git commit -m ":zap: perf: Melhoria no tempo de resposta"
|
⚡ perf: Melhoria no tempo de resposta |
git commit -m ":boom: fix: Revertendo mudanças ineficientes"
|
💥 fix: Revertendo mudanças ineficientes |
git commit -m ":lipstick: feat: Estilizaçao CSS do formulario"
|
💄 feat: Estilizaçao CSS do formulario |
git commit -m ":test_tube: feat: Estilizaçao CSS do formulario"
|
🧪 test: Criando novo teste |
git commit -m ":test_tube: feat: Estilizaçao CSS do formulario"
|
💡 docs: Comentários sobre a função LoremIpsum( ) |