0

Git: O que colocar nos comentários dos commits?

#GitHub #Git
João Soares
João Soares

Olá, colega!


Sabemos o quanto a padronização e documentação é importante quando falamos de projetos grandes, com várias pessoas envolvidas. Mas até mesmo para projetos pessoais, se a gente não documentar os nossos passos de maneira clara, é bem provável que com o tempo não vamos lembrar como o projeto foi construído!


Além disso, padrões podem ajudar bastante na automatização de processos. E se tem uma coisa que nós devs gostamos de fazer, é facilitar nossa vida com automatização!


Acabei de finalizar o curso "Introdução ao Git e Github" aqui da plataforma e me perguntei: será que existe algum padrão para escrita dos comentários de commits? Alguma norma, especificação?


Existe sim! É o Conventional Commits!


A sintaxe básica é bem simples: no começo do comentário, basta colocar uma palavra (tipo) que indique o contexto daquele commit no começo da mensagem:


git commit -m "<tipo>: <descrição>"


Os dois principais tipos se referem à uma nova feature ou uma correção de bug:


  • feat: nova feature no projeto
  • fix: correção de bug


Por exemplo, se eu quero criar commit com a correção de um bug, eu posso escrever da seguinte maneira:


git commit -m "fix: correção de bug no input do formulário"


Caso o commit precise de mais informações, a norma possui mais padrões que podem ser usados. Para mais detalhes, é só clicar no link.


Gostou, ficou com dúvida ou conhece alguma outra especificação? Deixe um comentário abaixo!


Valeu e até mais!


0
3

Comentários (1)

0
Pedro Dias

Pedro Dias

10/06/2021 16:55

Interessante isso aí, hein! :)


Valeu por compartilhar

Estudante de ciência da computação

Brasil