Skip to content

Instantly share code, notes, and snippets.

@kimjoaoun
Forked from matthewhudson/good-commit.md
Last active November 5, 2021 17:05
Show Gist options
  • Star 2 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save kimjoaoun/e607172abcb31f8cf3c2e52552b162da to your computer and use it in GitHub Desktop.
Save kimjoaoun/e607172abcb31f8cf3c2e52552b162da to your computer and use it in GitHub Desktop.
Uma boa mensagem de commit se estrutura da seguinte forma:
Cabeçalho: Explica o commit em somente uma linha.
O corpo da mensagem é composto por algumas linhas explicando a
coisa em detalhes, possivelmente dando um background acerca do
problema que fora reparado, etc etc.
O corpo da mensagem de commit pode ter vários parágrafos e,
por favor, faça quebre as linhas e mantenha as colunas menores
que aprox. 74 caracteres. Dessa forma o "git log" irá exibir
o texto corretamente mesmo quando está identado.
Reportado por: quem-reportou-o-erro(?)
Aprovado por: Seu Nome <seuemail@seuprovedor.com>
Sobre o cabeçalho ele realmente deve ter um significado claro, e deve
ser composto de somente uma linha. O cabeçalho é o que é exibido por
ferramentas como o "gitk" e "shortlog", devendo assim resumir a mudança
em somente uma linha de texto, independentemente da explicação longa.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment