6 boas práticas de Git

Publicado em: 20/4/2016

Utilizar o Git em seus projetos é uma boa solução, independentemente se o assunto em questão é front-end ou back-end. No entanto, como toda boa ferramenta, o Git oferece uma infinidade de opções e recursos que podem ser bem ou mal utilizados.

Pensando nisso, elaboramos este post com 5 boas práticas de Git para que você conheça mais sobre o assunto. Confira!

1. Utilize o modo imperativo

Por convenção, o Git usa sempre o modo imperativo nos  padrões de suas mensagens. Isso significa que, quando você  utiliza o merge ou um revert, essas ações seguem essa forma de comando e, por isso, na hora de elaborar os assuntos dos seus commits, é interessante que você siga essa regra também.

Uma dica boa para facilitar a criação dos commits, é validá-los usando a seguinte frase: “Se aplicado, esse commit vai” (ou, no inglês, “If applied, this commit will”). Veja um exemplo abaixo:

$ git log --oneline -4 

d759236 Change config to upload 

ae6a172 Merge branch 'assync-spam-job' into 'master' 

ef10959 Disable worker for spam learn. 

4210b8c Merge branch 'sentry-error-spam' into 'master

Neste caso, a frase ficaria da seguinte forma: “If applied, this commit will Change config to upload”. A princípio, pode parecer mais difícil escrever os commits dessa forma, já que é menos usual. No entanto, após pouco tempo de uso, a ação ficará bem mais fácil.

2.  Procure ser direto e explicativo em seus commits

Realmente, é muito mais rápido fazer um commit utilizando a sintaxe “git commit -m” e passando uma mensagem resumida do que foi feito. Porém, essa regra faz com que você perca a ideia original do commit, que é ser uma página na história do seu projeto, e não apenas um resumo em uma linha.

Nesse caso, o seu commit ficaria assim:

git commit -m ‘Adjust images on upload’

Com essa mensagem, um possivel leitor não entende porque essa modificação foi feita. Procure resumir o que foi feito na primeira linha, mas com algum detalhe, pular uma linha e descrever exatamente o que foi feito, se possível colocando algum link ou referência a tarefa que iniciou a modificação.

git commit -m”Appling auto-adjust images on upload to avoid distotiong

Users was uploading images to their profile but it was distorting the pics, now the pics are auto-adjusting.”

Dessa forma, além de deixar a sua ação mais completa, ainda é possível criar um resumo do assunto e um corpo para o seu commit, sem deixa de facilitar a leitura do histórico no git log:

$ git log --oneline -4 

4210b8c Appling auto-Aadjust images on upload to avoid distotiong

d759236 Change config to upload 

ae6a172 Merge branch 'assync-spam-job' into 'master' 

ef10959 Disable worker for spam learn. 

 

3. Considere incluir o link do card da sua história no commit

Incluir o link do card no commit facilita na hora de encontrar uma referência mais completa dos motivos pelos quais aquela história foi feita. Assim, é possível mostrar também alguns exemplos e, até, detalhes técnicos importantes.

4. Limite o assunto do commit a 50 caracteres

O número 50 é uma base para que o assunto possa ser lido por completo em qualquer interface. No entanto, essa regra não precisa ser seguida a ferro e fogo, ok?

Considere seguir um padrão entre os tópicos 2 e 3, utilize os 50 primeiros caracteres para um resumo do que foi feito e será visualizado em qualquer interface, que permita trabalhar uma mensagem mais detalhada nas próximas linhas.

5. Capitalize o assunto do seu commit

Por fim, capitalizar o assunto do seu commit é um ponto bastante importante para que ele seja encontrado mais facilmente em uma busca. Veja, a seguir, exemplos de commit com e sem capitalização:

Sem capitalizar o assunto

$ git log --oneline -5 

d2cad72 change config app to run 

d759236 change config to upload 

ae6a172 Merge branch 'assync-spam-job' into 'master' 

ef10959 disable worker for spam learn. 

4210b8c Merge branch 'sentry-error-spam' into 'master

Capitalizando o assunto

$ git log --oneline -5 

d2cad72 Change config app to run 

d759236 Change Config to upload 

ae6a172 Merge branch 'assync-spam-job' into 'master' 

ef10959 Disable worker for spam learn. 

4210b8c Merge branch 'sentry-error-spam' into 'master'

 

6. Nunca guarde arquivos binários no seu projeto

Apesar de ser uma ferramenta muito poderosa, o Git foi desenhado com um propósito voltado a arquivos de textos, principalmente com o foco em acompanhar mudançar nesses arquivos, normalmente códigos.

Normalmente, encontramos ferramentas que facilitam a vizualização do projeto através de uma imagem ou um PDF gerados, e ficamos tentados a guardar essa documentação no git, junto ao projeto. Porém esses documentos não versionados pelo git é feito com textos, e isso pode ocasionar o projeto a dobrar de tamanho a cada atualização desses arquivos.

Portanto, atente-se a passar indicações da utilização da ferramenta, preferencialmente através de um README, evitando salvar esses documentos junto ao projeto.

E então, gostou das boas práticas de Git que indicamos neste post? Tem alguma dúvida ou gostaria de compartilhar a sua opinião? Então, aproveite e deixe o seu comentário!

Publicado originalmente em Blog Locaweb