4

FAÇA O QUE DIZEMOS, NÃO O QUE FAZEMOS

#Trabalho Remoto #Git #Boas práticas
Juliana Borges
Juliana Borges


Como escrever um boa mensagem de commit


Leitura aproximada de 3 minutos a 5 minutos


Quem nunca ficou sem palavras ao escrever um bom commit message, teve pressa, preguiça ou imprudência? Quando se sabe que é preciso elaborar detalhes sobre o que foi feito no commit, mas se deixa levar pelos primeiros três motivos?



Como resolver esse problema?





Para iniciantes não é tão fácil elaborar bons commit messages, principalmente em projetos pessoais e pequenos.

Nesse artigo pode-se adquirir algumas dicas usadas para melhorar cada dia mais os commits.


Lembrete: Commit message é o resumo do trabalho que foi salvo no Git, assim quando for realizar o comando $ git log, você ou sua equipe entenderá o que foi feito em determinados commit.


A IMPORTÂNCIA DE ESCREVER UM BOM COMMIT MESSEGE:


É importante que se escreva boas mensagens mesmo se for um projeto pessoal e pequeno, pois ajuda muito no caso de outros desenvolvedores entrarem no projeto.

Hoje ainda não há uma maneira correta de se escrever commits, porém podemos usar boas práticas.



3 DICAS PARA DEIXAR SUAS COMMIT COM LEITURA FÁCIL e BEM SIMPLES



Use comandos que possam te ajudar


$ git commit -m "O titulo" -m "sua descrição"


1- No título ou primeira linha escreve-se o comando para o commit no modo Imperativo.


$ git commit -m "Adiciona instruções de commit messages" -m "sua descrição"


2 - Em detalhes ou na terceira linha, resumem-se os detalhes com as seguintes perguntas: O que foi feito? Por quê foi feito?

Usando uma escrita simplificada e objetiva o resultado será:


$ git commit -m "Adiciona instruções de commit messages" -m "Descrição Detalhada do Commi, onde você pode detalhar o que foi modificado em seu código e o porque foi modificado"



3- Caso haja a necessidade use Tags ou URL para detalhar melhor o projeto.


$ git tag -a v1.0 -m "Como escrever um bom commit messages"




COMMIT MESSAGE FINALIZADA:




Agora caso goste de usar um texto mais descontraído e de usar emojis, saiba que é possível no commit messages. O gitmoji tem um ótimo recurso para isso.

https://gitmoji.dev/


git commit -m ":memo: Adiciona instruções de commit messages" -m " Foi criado o arquivo CONTRIBUTING.md com as instruçoes de como fazer um bom commit, para judar a equipe na produtividade do projeto :rocket:"



Aprofunde-se no assunto! Aqui tem alguns site e blog que possa te ajudar:


Conclusão

Por fim, estimo que tenha gostado!!



Ah, tenho mais algumas dúvidas, você pode me ajudar? Devo escrever em Português, Inglês, ou idioma nativo de onde o projeto foi iniciado? Ou tudo junto e misturado? Caso tenha essa dica, não hesite em deixar no comentário !!



2
53

Comentários (4)

1
Rosimeire Pereira

Rosimeire Pereira

26/03/2021 11:12

Que top Juliana , gostei muito valeu,daí importância e prática,top top

1
Leonardo Oliveira

Leonardo Oliveira

26/03/2021 10:47

Muito bom Juliana. Obrigado por compartilhar o seu conhecimento. Foi muito útil pra mim.


Respondendo a sua pergunta sobre em qual idioma escrever os commits, a resposta que tenho encontrado dos meus instrutores é que devemos escrever preferencialmente em inglês, porque facilita a colaboração de devs do mundo todo nos projetos, já que o inglês é um idioma global.

1
Lilian Castanha

Lilian Castanha

26/03/2021 10:10

Parabéns Juliana, adorei, por ser iniciante vou aplicar suas dicas! Muito Obrigada

1
🏂⚡️Eros M.Lima

🏂⚡️Eros M.Lima

26/03/2021 09:58

hahah só entrei para ler a tirinha mesmo, top Juliana vlw!

acho que se tu postar muitos deste pode ficar conhecida por isso em, eu vou de dilbert:


🤣 Rolling on the Floor Laughing

Dev estudando sempre

Brasil