5 boas práticas de Git

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 seus padrões. Isso significa que, quando você faz um 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. Nunca use o Git “commit -m / –message=”

Realmente, é muito mais rápido fazer um commit utilizando a sintaxe “git commit -m”. 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’

Mas, ao inserir a mensagem no Git de forma completa, você teria o seguinte resultado:

Adjust images on upload
https://trello.com/PROJECT/CARD
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 assunto e um corpo para o seu commit.

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?

Normalmente, é muito fácil escrever um título com 50 caracteres. E, caso haja dificuldade nesse ponto, pode ser que o seu commit esteja com mais informações do que o necessário .

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'

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!