Skip to content

Instantly share code, notes, and snippets.

@fnoquiq
Last active June 24, 2024 17:53
Show Gist options
  • Save fnoquiq/12f7800b219ff03de84ab10dba24e9af to your computer and use it in GitHub Desktop.
Save fnoquiq/12f7800b219ff03de84ab10dba24e9af to your computer and use it in GitHub Desktop.
Mensagens de commit styleguide

Styleguides

Mensagens de commit styleguide

  • Usar modo imperativo (uma dica é fazer a pergunta: "O que este commit faz?" e responder: "Este commit Adiciona feature)
    • "Adiciona feature" 👍🏻
    • "Adicionada feature" 💩
    • "Adicionando feature" 💩
  • Primeira linha (título) deve ter no máximo 72 caracteres
  • Primeira linha (título) não deve terminar com ponto final '.'
  • Considere descrever com detalhes no corpo do commit
  • Considere usar um emoji na primeira linha (título) do commit, conforme a tabela abaixo:
Emoji Código Tipo de Commit Referência (semantic convecional commit)
🎉 :tada: Commit inicial, ao definir a estrutura do projeto. chore
🚀 :rocket: Ao adicionar uma nova feature ou testes feat
🎨 :art: Ao refatorar o código, sem alterar a funcionalidade. Como ao alterar formatação e etc... style
🐛 :bug: Ao corrigir um bug. fix
📝 :memo: Alterações na documentação. docs
↕️ :arrow_up_down: Ao alterar dependências ou merge em branchs. chore
🙈 :see_no_evil: Gambiarras (não use este :/). chore

Exemplo

git commit
- > :memo: Adiciona instruções de contribuição
- >
- > Foi criado o arquivo CONTRIBUTING.md com as instruções de
- > como fazer um bom commit"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment