Skip to content

Instantly share code, notes, and snippets.

@Edclydson
Created March 23, 2023 21:48
Show Gist options
  • Save Edclydson/867bef6ed60f24c0a070d41649668d74 to your computer and use it in GitHub Desktop.
Save Edclydson/867bef6ed60f24c0a070d41649668d74 to your computer and use it in GitHub Desktop.
Sugestões para padronizar mensagens de commits

A mensagem do commit deve ser estruturada da seguinte forma:

:emoji: (escopo): <descrição>

  • Os commits terão um emoji para dar uma identificação visual a mensagem, um tipo, um escopo para dar contexto, e uma descrição onde poderá colocar os detalhes do commit.

OBS: O emoji e o escopo são opcionais, porém é recomendado que siga o escopo a cima.

Tipos de Commits

O commit possui os elementos estruturais abaixo (tipos), que informam a intenção do seu commit ao utilizador(a) de seu código.

fix

  • Commits do tipo fix indicam que seu trecho de código commitado está solucionando um problema (bug fix), (se relaciona com o PATCH do versionamento semântico).

feat

  • Commits do tipo feat indicam que seu trecho de código está incluindo um novo recurso (se relaciona com o MINOR do versionamento semântico).

docs

  • Commits do tipo docs indicam que houveram mudanças na documentação, como por exemplo no Readme do seu repositório. (Não inclui alterações em código).

style

  • Commits do tipo style indicam que houveram alterações referentes a formatações de código, semicolons, trailing spaces, lint... (Não inclui alterações em código).

refactor

  • Commits do tipo refactor referem-se a mudanças devido a refatorações que não alterem sua funcionalidade, como por exemplo, uma alteração no formato como é processada determinada parte da tela, mas que manteve a mesma funcionalidade, ou melhorias de performance devido a um code review.

build

  • Commits do tipo build são utilizados quando são realizadas modificações em arquivos de build e dependências.

test

  • Commits do tipo test são utilizados quando são realizadas alterações em testes, seja criando, alterando ou excluindo testes unitários. (Não inclui alterações em código)

chore

  • Commits do tipo chore indicam atualizações de tarefas de build, configurações de administrador, pacotes... como por exemplo adicionar um pacote no gitignore. (Não inclui alterações em código)

Emojis:

Tipo de commit Emojis
Commit inicial 🎉 : t a d a :
Tag de versão 🔖 : b o o k m a r k :
Novo recurso ✨ : s p a r k l e s :
Lista de ideias (tasks) 🔜 : s o o n :
Bugfix 🐛 : b u g :
Documentação 📚 : b o o k s :
Testes 🧪 : t e s t _ t u b e :
Adicionando um teste ✅ : w h i t e _ c h e c k _ m a r k :
Teste de aprovação ✔️ : h e a v y _ c h e c k _ m a r k :
Acessibilidade ♿ : w h e e l c h a i r :
Texto 📝 : p e n c i l :
Package.json em JS 📦 : p a c k a g e :
Em progresso 🚧 : c o n s t r u c t i o n :
Arquivos de configuração 🔧 : w r e n c h :
Removendo uma dependência ➖ : h e a v y _ m i n u s _ s i g n :
Adicionando uma dependência ➕ : h e a v y _ p l u s _ s i g n :
Revertendo mudanças 💥 : b o o m :
Alterações de revisão de código 👌 : o k _ h a n d :
Refatoração ♻️ : r e c y c l e :
Mover/Renomear 🚚 : t r u c k :
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment