Guia para iniciantes do Git – Como escrever uma boa mensagem de confirmação


Você é desenvolvedor e começou a usar o Git recentemente? Se você está se perguntando qual é a melhor maneira de criar uma boa mensagem de confirmação para o seu projeto, este artigo foi feito para você.

Depois de algumas semanas sem escrever novos artigos, volto hoje com a próxima parte de uma das minhas postagens mais pesquisadas no Google.

Quando comecei a escrever, um ano atrás, criei um artigo sobre como iniciar e criar seu primeiro repositório com Git.

Este artigo é apreciado pela comunidade e ajuda muitas pessoas a cada semana. Assim, a próxima parte desta série será como escrever uma boa mensagem de confirmação.

O que é uma boa mensagem de confirmação?

Como um lembrete breve, a mensagem de confirmação é o texto breve que você deixou ao salvar seu trabalho no Git. Esta mensagem tem o objetivo específico de identificar seu trabalho.

Apenas lendo, você será capaz de lembrar o que fez nesta parte do seu trabalho.

Um bom exemplo de confirmação

Abaixo, você encontra um exemplo dos últimos commits no projeto Angular.js no GitHub (um famoso framework criado pelo Google). Como você pode ver, as mensagens são claras e podemos entender melhor qual trabalho foi realizado em diferentes partes.

Por exemplo, em 24 de julho de 2019, o “gkalpak” atualizou o “SauceConnect” e passou para a última versão do Safari (navegador da web).

Git confirma história
Git confirma histórico no projeto Angular.js no GitHub

Por que todo mundo não está cometendo da mesma maneira?

Infelizmente, os commits não têm uma maneira universal de serem escritos. Cada projeto e cada empresa definem regras específicas para suas necessidades.

Não se preocupe; você encontrará frequentemente maneiras semelhantes de escrever a mensagem.

No entanto, eu recomendo que você leia as regras antes de iniciar uma empresa ou trabalhar em um projeto de código aberto.

Darei a você mais detalhes sobre essas diretrizes posteriormente neste artigo.

Por que é essencial escrever bem o seu commit

Criei uma lista restrita das vantagens de usar uma boa mensagem de confirmação.

  • Uma colaboração melhor: Se você estiver trabalhando em uma empresa, 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, os outros desenvolvedores poderão trabalhar com mais eficiência e não precisarão fazer perguntas sobre seu trabalho.

Nota: Se você estiver trabalhando em um projeto pessoal, é altamente recomendável que você siga regras específicas. Isso aumentará sua produtividade e, se você pedir ajuda a outro desenvolvedor, será mais fácil para ele começar a trabalhar em seu projeto.

  • Um melhor entendimento: Você precisa criar mensagens claras e compreensíveis; isso ajudará você e seu colaborador a trabalhar em um projeto. Abaixo, você pode encontrar um exemplo de um histórico de confirmação do git com apenas mensagens pouco claras. Como você pode ver, é difícil entender o que é feito.
  • BÔNUS – Uma geração de changelog: Vou lhe contar um pequeno segredo: se você escrever boas mensagens, poderá gerar um log de alterações diretamente de suas mensagens de confirmação. Compartilho com você algumas ferramentas para fazer isso: Github Changelog Generator, Git Chglog, Registro de alterações automáticoe Registro de alterações convencional. Provavelmente, a próxima parte da série será sobre isso, se você quiser ser atualizado, você pode me seguir no Twitter. Eu posto todas as atualizações lá.

Exemplo de commit incorreto
Bad git confirma exemplo de Jason McCreary

Registro de alterações Git gerado automaticamente
Exemplo de log de alterações Git gerado automaticamente

Como escrever uma mensagem de confirmação?

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. Se você está escrevendo em inglês, pode usar Grammarly, Reversoou Verificação de gramática. Essas ferramentas não são perfeitas, mas removerão a maioria dos seus erros.
  • Um commit, uma mudança. Tente se comprometer com frequência. O 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 o inglês simples para ir direto ao ponto.
  • Detalhes o que você fez. Reserve um tempo para reler seu código e escrever o que você fez. No caso de você precisar detalhar muito, recomendo que você use a parte da descrição do commit.

INFORMAÇÃO ADICIONAL: Quero compartilhar com você mais detalhes sobre o comando ‘git commit’. Se você não estiver usando um software git, saiba que é possível criar uma consolidação detalhada digitando este comando:

$ git commit -m "Title" -m "Description"

É o mesmo de antes, mas com uma segunda parte para a descrição. Portanto, “-m ‘title'” é escrever o título abreviado do commit e “-m ‘description'” é escrever a descrição se você precisar fornecer mais detalhes.

  • Use uma diretriz git. Se você deseja ter um histórico claro de confirmação do git, recomendo que você siga uma diretriz. É um guia de como se comprometer. No meu caso, eu escolho este simples da Udacity. Existem muitos outros; alguns deles são Compromissos convencionaise Diretriz Angular. Uma diretriz de consolidação ajudará você a colocar uma arquitetura em sua consolidação. Por exemplo, coloque uma tag para esclarecer o que você fez: “git commit -m fix: exclua corretamente todas as informações do usuário quando o botão excluir conta for acionado ‘”.

Conclusão

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.

Se você tiver outras dicas sobre como fazer boas confirmações, entre em contato.

Não perca meu conteúdo, seguindo-me no Twitter e Instagram.

Você pode encontrar outros artigos como este no meu site: herewecode.io.

Quer mais?

  • A cada semana, faça uma cotação motivacional com alguns conselhos, um breve tutorial em alguns slides e a foto de um desenvolvedor sobre Instagram.
  • Assine a newsletter e obtenha os artigos, cursos, tutoriais, dicas, livros, motivação e outros conteúdos exclusivos mais recentes.





Fonte

Leave a Reply

Your email address will not be published. Required fields are marked *