DEV Community

João Gabriel Marinho
João Gabriel Marinho

Posted on

Maximizando a eficiência do versionamento com padrões de commits no GitHub

Resolvi escrever este post para dar mais destaque a este tema.

Enquanto estudava e enviava projetos para o Git, comecei a perceber que meus commits não estavam com o contexto muito claro. Então, comecei a pesquisar se existiam padrões que poderiam ser usados para que as mensagens dos commits ficassem mais diretas ao ponto e fáceis de entender. Juntei conhecimentos de várias pesquisas e opiniões para criar uma lista de padrões que melhorassem a produtividade da equipe com mensagens de commits mais claras.

A seguir, apresento uma lista com cinco padrões efetivos para commits.

  1. Mensagem clara e concisa: a mensagem de commit deve ser clara e descrever a mudança feita de maneira concisa. Ela deve ser informativa o suficiente para que outros desenvolvedores possam entender a mudança sem precisar revisar o código.

  2. Prefixos de commit: muitos projetos usam prefixos em suas mensagens de commit para indicar o tipo de mudança realizada. Alguns exemplos de prefixos comuns incluem "feat" para novas funcionalidades, "fix" para correções de bugs e "docs" para atualizações de documentação.

  3. Linha de assunto e corpo: algumas equipes preferem separar a mensagem de commit em uma linha de assunto curta e um corpo mais detalhado que explica a mudança em mais detalhes. Isso pode ajudar a tornar as mensagens de commit mais fáceis de ler e entender.

  4. Mensagens em inglês: como o inglês é uma linguagem comum no desenvolvimento de software, muitas equipes optam por usar o inglês em suas mensagens de commit para garantir que elas possam ser entendidas por desenvolvedores em todo o mundo.

  5. Consistência: independentemente do padrão específico que você escolher para suas mensagens de commit, é importante ser consistente e seguir esse padrão em todos os commits. Isso tornará mais fácil para outras pessoas entenderem as mudanças que você fez ao longo do tempo.

Top comments (2)

Collapse
 
paulorrrrr profile image
PauloRRRRR

Pse, a comunicação é uma das partes fundamentais quando se trata de programação, a universalização e padronização da linguagem em que nos comunicamos como você mencionou, pode tornar todo o processo muito mais eficiente.

Collapse
 
pedropietro profile image
Pedro Pietroluongo

Lembrando que se errar é só usar o git amend. Segue a indicação de artigo explanando sobre: dev.to/womakerscode/tutorial-git-c...