Quem nunca viu ou abriu um PR/MR sem descrição, né!? 💩

Agora vamos passar disso aí pra isso aqui:

Como que faço isso?

Simples, simples, simples.

Github:

• Add na raiz do seu projeto um arquivo markdown com esse nome pull_request_template.md e taca na main.
• Insere lá esse markdown aqui e prontinho.
• No seu próximo PR ela já aperce automágicamente.

Gitlab:

• Add no seu projeto um arquivo markdown com esse nome .gitlab/pull_request_template.md e taca na main.
• Insere lá esse markdown aqui e prontinho.
• Na hora de abrir um MR é só escolher o template na descrição:

Pra que cê vai gastar mais tempo meu?

Documentação

Pra ter registrado de forma legível para devs e não devs o que foi feito, quando, como, porquê. Isso na hora de demonstrar seu trabalho com sua liderança é ótimo.

Evitar retrabalho

Devs tem que entender código, mas saber porquê você fez as alterações e uma breve explicação das lógicas vai economizar tempo com dúvidas e ajudar num code review menos cansativo. Pegar melhorias na etapa de code review é muito melhor que pegar com pressão do seu tech lead ou PO.

Use, adapte ao seu cenário e seja feliz. E pra deixar ainda mais lindo e de fácil rastreio eu indico DEMAIS esse cara aqui: https://gitmoji.dev/