"Git" juntos: algumas dicas sobre etiqueta de compromisso e práticas recomendadas para desenvolvedores júnior

Foto de Olu Eletu no Unsplash .

Eu me sinto extremamente sortudo por ter sido instruído no básico do Git-etiquette essencialmente no primeiro dia da minha jornada para se tornar um engenheiro de software (Obrigado, Krailo !). Um conceito aparentemente menor, foi uma das primeiras coisas que me ensinou como desenvolvedor em desenvolvimento e, consequentemente, coloquei sobre ele a importância que me foi transmitida naquela educação.

Surpreendentemente, parece-me que há muitos desenvolvedores que parecem não estar familiarizados com o uso e o não fazer, possivelmente, a ferramenta mais onipresente no desenvolvimento de software, o Git. Uma vez que muitos programadores aprendem o Git on-the-job, provavelmente não são treinados nas melhores práticas para algo considerado mais de uma habilidade suave, e é duvidoso que alguém opte por usar a git-etiquetada pobre. No entanto, o problema ainda é desenfreado entre os desenvolvedores de todos os níveis de habilidades.

Não se preocupe, porém, a solução não exigirá horas de leitura e mudando completamente seu fluxo de trabalho. Na verdade, é um problema bastante fácil de resolver, e apenas exige que você siga algumas diretrizes fáceis de lembrar.

Então, vamos começar com alguns dos conceitos básicos. O conhecimento ea implementação desses conceitos ajudarão você a fazer os primeiros passos de greeny-junior para Git-guru.

Use a CLI e um editor …

.. e parar de usar git commit -m “Useless message here"

Tentando encaixar uma mensagem de confirmação bem formada em um único comando não funciona.

Uma mensagem de compromisso deve demorar um minuto.

Você deve ter que parar e raciocinar sobre o trabalho que você acabou de fazer para explicá-lo a outros que possam trabalhar no projeto, bem como você, futuro futuro, se você precisar revisar essas mudanças.

Escrever uma mensagem bem pensada é a sua maneira de escrever na "história" as mudanças que você fez e explicando o que você mudou e por quê.

Quando você toma o tempo para compor suas mensagens em uma janela de editor de texto (em oposição à linha de comando), você irá diminuir a velocidade e certificar-se de que suas mudanças estão completas e vale a pena compartilhar, além de permitir que você seja mais descritivo em sua explicação de por que as mudanças eram necessárias.

Quando você usa o editor para compor mensagens, ele pode ajudar a capturar erros em seu código muito mais cedo.

Por exemplo, eu uso os alias Oh-My-Zsh git no meu fluxo de trabalho. O comando gc expande em git commit --verbose que abrirá seu editor padrão com um resumo de suas mudanças atuais sob a forma de comentários. O que é encenado, o que não é, arquivos não rastreados e uma diferença das mudanças que você está cometendo no momento, permitindo que você analise as alterações à medida que você está escrevendo sua mensagem de confirmação.

Dica : ler através dos diffs antes de escrever sua mensagem pode salvá-lo de cometer o código do "depurador" e / ou ajudar a detectar um erro de digitação / ortografia que normalmente não seria pego até a revisão do código.

Siga o formato de mensagem de confirmação apropriado

A linha de título

Ao compor uma linha de título, tento e segui 3 regras :

  1. A linha do título começa com uma letra maiúscula, é de 50 caracteres (ou menos), e não tem pontuação no final.
  2. Deve ser na voz imperativa. ou seja, "Adicionar nova página Sobre nós" ou "Testes de refatoração para o modelo de ordem"
  3. Deverá completar corretamente a sentença,
    “If accepted, this commit will <your commit message goes here>.”

Uma mensagem de confirmação super-básica usando gramática e estrutura adequada. (`git commit – verbose` usandoNeovim)

O corpo

Um breve resumo das mudanças. Se as mudanças fossem simples o suficiente, elas podem ser entendidas com apenas uma linha "Título", então você pode optar por sair desta seção (a imagem acima é um bom exemplo de mudanças que não precisam de uma explicação detalhada).

O corpo deve explicar o "o que" eo "porquê" para suas mudanças, e não o "como". Qualquer pessoa que lê o código deve poder discernir como você implementou sua mudança. Use a seção do corpo para cobrir as peças que podem não ser tão óbvias.

Um exemplo de mensagens de compromisso bem detalhadas com seções explicativas do corpo

Dica: se você estiver usando um sistema de gerenciamento de tickets (Trello, Jira, etc.), INCLUEM O LINK PARA O CARTÃO / EDIÇÃO . É uma boa referência para qualquer um que reveja seus PRs que podem não estar familiarizados com o problema ou com outros desenvolvedores que trabalham no mesmo projeto.

Seja atômico e mantenha as mudanças em conjunto em compromissos relacionados

Agrupe como mudanças em conjunto no mesmo commit

Nem mesmo perto do agrupamento lógico

Não jogue algumas alterações de configuração e novos CSS na mesma confirmação. Deslize as coisas de maneira lógica. (Lembre-se, mesmo que você faça mais de um pedaço de mudanças por vez, você ainda pode comprometê-las de maneira sensata, agrupadas por mudanças semelhantes)

As mesmas mudanças a partir da imagem anterior, mas quebradas em mais compromissos "atômicos".

Seus compromissos mostram a progressão do seu código. Torne uma história fácil de seguir. Mesmo que isso não pareça importante neste momento, ser capaz de seguir o histórico do seu código pode ajudá-lo a localizar a origem das regressões através de dedução lógica ( esse erro JS no console provavelmente não é da confirmação em que você atualizou CSS e mudou alguns ícones no rodapé ).

O log Git de um recurso em que trabalhei recentemente.

Isso não é tudo o que você precisa saber usar git magistralmente, mas é uma base sólida a partir da qual construir. O conhecimento de suas ferramentas e a melhor maneira de usá-las é apenas uma facetada de se tornar um desenvolvedor de alta qualidade. A atenção a essas coisas "pequenas" ajudará você a tornar-se mais produtivo e tornar o trabalho com você muito mais agradável. Mesmo que a única pessoa que colhe esses benefícios tenha dez semanas de agora, você.

Sim, algo tão pequeno como a forma de suas mensagens de compromisso pode parecer sem importância ou tedioso, mas a atenção para as coisas pequenas e promover bons hábitos é a chave para o sucesso.

"Nós somos o que repetidamente fazemos; A excelência, portanto, não é um ato, mas um hábito. "- Aristóteles

Deixe uma resposta

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *