today   22 de setembro de 2017

access_time  7 mins de leitura

Git: Melhores práticas

Algumas boas práticas ao utilizar sua ferramenta de versionamento. Nomeando commits e branchs

Por que versionar o código de seu projeto?

Versionamento é algo importantíssimo quando estamos falando de desenvolvimento de software. Uma ferramenta de versionamento bem organizada torna muito mais fácil a comparação de arquivos, realização de mesclagem de ramos (merge) ou até rollbacks de emergência no ambiente de produção.

Primeiramente, o ramo principal master nunca deveria ser seu branch de trabalho.

Mas por que?

Simplesmente não faça isso. É extramente mais complicado manter seu código organizado desta maneira. Em um projeto open-source por exemplo, seria muito mais difícil para pessoas de fora entenderem quais funcionalidades entraram e em qual versão do projeto elas entraram. Será muito mais difícil identificar e dar rollback em um bug que foi inserido no seu software quando todos seus commits foram no mesmo branch. Mesmo que seu projeto não seja open-source, quando novos desenvolvedores entram no projeto, um processo precisa existir:

Imagine um time com 3 ou mais pessoas trabalhando e commitando no mesmo branch: isso pode desencadear diversos conflitos! É mais difícil controlar e garantir o funcionamento de seu sistema como um todo, pois as modificações de outros podem interferir nas suas, isso sem falar que, se todos estão mandando tudo direto para o master, não há um processo sólido de de revisão de código (code review).

Nomeando suas branches

Primeiramente, quando trabalhando em uma nova funcionalidade, o desenvolvedor deveria originar seu branch à partir de um ambiente estável, geralmente o master, com um nome que realmente descreve sobre o que é aquela funcionalidade sendo desenvolvida.

De nada ajuda e não faz sentido para os desenvolvedores que não estão trabalhando naquele branch se ele foi nomeado, por exemplo, baseado em um código identificador/id de ferramentas de gerenciamento tais como Jira, Trello, etc..

Um bom nome em seu branch ajuda desenvolvedores revisarem o código quando existem várias branches em seu repositório local, um exemplo ao executarmos o comando git branch:

$ git branch
  .
  .
  TASK-316
  TASK-322
  TASK-340
  TASK-341
  TASK-345
  TASK-348
  TASK-380
  TASK-387
  .
  .

Qual o propósito destes branchs?

Algumas simples regras podem ser seguidas ao originar seu novo branch:

  • O nome deve ser simples conciso, que represente sua tarefa;
  • Um único idioma deve ser utilizado;
  • Não utilize códigos que não tem sentido quando sem contexto;
  • Começar com letras minúsculas;
  • Palavras separadas por hífens -.

Além disso, algumas tokens podem ser definidas em seu projeto que vão sempre preceder os nomes de seus ramos:

Nome do Branch Descrição
feature-< name > Quando desenvolvendo uma nova funcionalidade ou melhoria
bug-< name > Quando há um bug que necessita de correção e mesclagem
hotfix-< name > Quando há a necessidade de uma ação imediata em um comportamento indesejado no sistema

Por exemplo, se você está desenvolvendo uma nova funcionalidade implementando User Portal, um bom nome para seu branch poderia ser:

$ git checkout master && git pull
$ git checkout -b 'feature-user-portal'
$ git push -u origin 'feature-user-portal'

Mensagens de commit

Por que alguém deveria escrever mensagens de commit fáceis de entender?

Enquanto estava escrevendo este artigo, procurando alguns exemplos de mensagens de commit não muitos boas e então me deparei com este site. Não commita cometa este mesmo erro.

Um commit bem escrito, conciso e consistente é fundamental quando utilizando git log e claro, esta é uma ferramente muito importante e poderosa quando trabalhando com versionamento de código. Além disso, é uma ótima maneira de comunicar modificações para outros desenvolvedores e para seu futuro eu também (quem nunca fez algo e depois não lembrava o porque de ter feito? :thinking: ).

Em um projeto grande e de longo termo, o seu sucesso é fortemente dependente de sua manutenabilidade e por essa razão é muito importante para aqueles que mantém o projeto conseguirem utilizar efetivamente o log do projeto.

Entendendo commits de outros e seus pull requests torna muito mais fácil de entender quando existe uma descrição (mesmo que breve) do que foi feito.

Existem algumas regras que ajudam a compor uma boa mensagem de commit, ao digitar git commit, o editor configurado na opção core.editor de seu .gitconfig vai abrir para que a mensagem de commit seja escrita e então as seguintes regras podem ser seguidas:

  1. Separe as linhas de assunto e corpo do commit com uma linha em branco
  2. Limite o tamanho da linha do assunto para 50 caractéres (colunas)
  3. Letra maiúscula no início do assunto
  4. Não termina o assunto com um ponto fina
  5. Utilize o modo imperativoo na linha do assunto
  6. Encapsule corpo do commit em 72 colunas
  7. Utilize o corpo para explicar o o que e o porque vs. como.

Se você estiver comitando algo não muito complexo que não necessita de uma explicação detalhada, é possível adicionar uma mensagem ao commit passando a flag -m, porém, evite:

$ git commit -m'Summarize changes in around 50 characters or less'

Um exemplo agora de uma boa mensagem de commit:

$ git commit

Dentro de seu editor:

# Subject:
Exemplify a good commit message

# Metadata (optional):
Resolves TASK-340

# Body:
This commit message body is used to explain the changes
inside the commit that is not simply explained through a
simple one-liner subject mesage.

Para que se torne mais fácil e automática a escrita de boas mensagens de commit, o git permite que seja definido um prepare-commit-msg hook em que todos seu commits dispararão esse gatilho antes de você escrever sua mensagem de commit, assim ter permitindo adicionar algumas informações padrões nas mensagens.

Revisão de código (code review)

Beleza, você já criou uma branch com um nome coerente e também descreveu todos seus commits com mensagens de commit claras e objetivas seguindo algum tipo de padrão. O que fazer agora?

O próximo passo seria mesclar/mergear suas modificações ao branch de onde seu working branch foi originado. Para que isso ocorra de maneira ideal, primeiramente é muito importante que suas alterações no código não quebrem outras funcionalidades do software e para garantir isso,é legal que aquelas suas alterações sejam cobertas com testes automatizados e mais importante, se sua aplicação já possuir uma suíte de testes, suas modificações não devem quebrar nenhum dos testes existentes.

Existem algumas ferramentas que ajudam os desenvolvedores no processo de merge, executando os testes automáticos do sistema e só permitindo a mesclagem caso eles passem, mas este é um outro tópico.

Terminando o desenvolvimento da sua funcionalidade é muito importante que outros desenvolvedores revisem seu código. Isso ajuda muito no crescimento técnico do time, quem revisa aprende e quem tem seus commits revisados aprende muito também. Esta etapa do processo deve sempre acontecer quando trabalhando em time.. ninguém é perfeito! Outras pessoas podem identificar erros no seu código, ou identificar casos de testes que não foram previstos na implementação desenvolvida por você.

Isso tudo acontence quando um Pull Request é aberto, que nada mais é do que a intenção de mesclar suas modificações ao branch de onde foi anteriormente originado. Lembre-se que todos os comentários realizados em um Pull Request não devem ser levados como uma crítica pessoal e sim oportunidades de crescimento profissional, você vai aprender com estes comentários.

Depois de possíveis alterações e melhorias acontecerem no seu Pull Request e ele for aprovado para o merge, vá em frente! :grimacing:

Concluindo

Estas são apenas algumas boas práticas para seu controle de versões git que acredito facilitar a vida de desenvolvedores quando trabalhando em uma equipe dentro de um mesmo repositório. Espero que o conteúdo tenha ficado claro e de fácil compreensão.

– Abraços.

Comments