Guia para iniciantes do Git – Como escrever uma boa mensagem de commit
Você é um desenvolvedor que começou a usar o Git recentemente? Se você está se perguntando como criar uma boa mensagem de confirmação para o seu projeto, este artigo foi feito para você.
O que é uma boa mensagem de commit?
Como um lembrete breve, uma mensagem de commit é um texto que resume o trabalho que você salvou no Git.
A ideia é que, apenas lendo essa mensagem, você seja capaz de lembrar o que fez naquela parte do seu código.
Um bom exemplo de commits
Abaixo, você encontra as últimas confirmações no projeto Sequelize no GitHub. Como você pode ver, as mensagens são claras e podemos entender melhor qual trabalho foi realizado em diferentes partes.
Repare no commit do usuário “sushantdhiman” no dia 16 de março de 2020. Fica muito claro qual foi a alteração enviada no seu commit. Uma mensagem resumida e direta.
Por que todo mundo não está cometendo da mesma maneira?
Infelizmente, não há uma maneira universal de escrever commits. Cada projeto e cada empresa definem regras específicas para suas necessidades.
Mas não se preocupe – você geralmente encontrará maneiras semelhantes de escrever uma mensagem de commit.
Para descobrir o que são, eu recomendo que você leia as regras antes de começar em uma empresa ou trabalhar em um projeto de código aberto.
Darei a você mais detalhes sobre essas diretrizes posteriormente neste artigo.
Por que é importante escrever bem seu commit
Abaixo eu criei uma lista, com alguns motivos da importância de boas mensagem de commit.
Melhor colaboração
Se você estiver trabalhando em uma empresa ou em um projeto de código aberto, é essencial seguir as regras para uma melhor cooperação. Se você escrever algo compreensível, seguindo as regras do projeto, outros desenvolvedores poderão trabalhar com mais eficiência. Eles não terão que fazer perguntas sobre o seu trabalho.
Nota: Se você estiver trabalhando em um projeto pessoal, eu recomendo que você também siga regras específicas.
Isso aumentará sua produtividade e, se você precisar de ajuda de outro desenvolvedor, será mais fácil começar a trabalhar no seu projeto.
Melhor entendimento
Você precisa criar mensagem claras e compreensíveis. Isso ajudará você e seu colaborar a entender facilmente o teor do seu commit.
Gere um log de alterações
Se você tiver boas mensagem de commit, poderá algumas ferramentas para gerar um log de todas as modificações ao longo do tempo no seu projeto.
Aqui tem algumas ferramentas para esse tipo de trabalho.
Como escrever uma boa mensagem de commit
Se você quiser escrever uma boa mensagem de confirmação, siga algumas regras. Criei uma lista de verificação abaixo. Toda vez que você deseja confirmar, reserve um tempo para consultar esta lista.
- Sempre verifique sua gramática. Nunca é agradável ler uma mensagem cheia de erros. Para fazer isso, eu recomendo que você use uma ferramenta de gramática.
- Um commit, uma mudança. Tente se comprometer com frequência. É ideal ter cada alteração em um commit diferente. Será mais fácil voltar ao trabalho anterior.
- Seja claro. Ao escrever um commit, tente ser o mais transparente possível. Eu recomendo que você use inglês simples e vá direto ao ponto.
- Detalhe o que você fez. Reserve um tempo para reler seu código e escrever o que você fez. Caso você precise adicionar muitos detalhes, use a parte da descrição do commit.
O comando git commit
Olha essa dica incrível. Você pode passar um segundo parâmetro no comando git commit, nele você pode escrever mais detalhes sobre seu commit.
$ git commit -m "Title" -m "Description"É o mesmo comando que você já conhece, mas com uma segunda parte para a descrição. Portanto, “-m ‘title'” permite que você escreva o título abreviado do commit, e “-m ‘description'” permite que você escreva a descrição se precisar fornecer mais detalhes.
Use diretrizes git
Se você deseja ter um histórico claro de confirmação do git, siga algumas diretrizes. Aconselho este da Udacity .
Por exemplo, adicionando uma tag para esclarecer o que você fez: “git commit -m ‘fix: altere corretamente a cor do botão ao clicar'”.
Caso queira algo mais visual. o Gitmoji é um guia de mensagem de commit bastante interessante.
Concluindo
Espero que você tenha gostado deste guia sobre como se comprometer com o Git! Se você tiver alguma dúvida ou comentário, não hesite em perguntar.