Melhorar a seção 'Crie um PR' dos arquivos de contribuição adicionando boas práticas para títulos e descrições

[camilamaia]

Descrição

Atualizar a seção "Crie um PR" nos arquivos de contribuição para incluir informações mais detalhadas sobre as boas práticas ao criar um Pull Request. As mudanças devem ser feitas nas seguintes páginas:

• CONTRIBUTING.md (PT-BR)
• CONTRIBUTING_EN.md (EN)

Mudanças a serem feitas

1. Importância de títulos bem descritivos:
   Adicionar informações sobre como títulos de PRs bem descritos ajudam na organização e rastreabilidade do projeto.
   Dar exemplos, como: "Adicionando utilitário convert_uf_to_text"

   Explicar os benefícios:

   • Títulos bem descritos facilitam a identificação do propósito do PR e aumentam a clareza para os revisores.
   • Aumenta as chances de o PR ser revisado mais rapidamente.

2. Descrição detalhada do PR:
   Destacar a importância de uma boa descrição no PR, incluindo:

   • O que foi feito.
   • Por que foi feito.
   • Quais problemas foram resolvidos ou melhorias foram aplicadas.

   Explicar os benefícios:

   • Aumenta as chances de o PR ser revisado mais rapidamente.
   • Facilita o entendimento do código, tanto para revisores quanto para quem dará manutenção no futuro.

3. Linkar a Issue no PR:
   Reforçar a necessidade de linkar o PR com a issue relacionada utilizando palavras-chave como Closes #<número-da-issue> ou Fixes #<número-da-issue> na descrição do PR. Isso ajuda a automatizar o fechamento da issue quando o PR for mergeado, mantendo o repositório mais organizado e as tarefas bem gerenciadas.

   linkar docs:

• PT: Documentação GitHub sobre fechamento automático de issues
• EN: Documentação GitHub sobre fechamento automático de issues

4. Verificar os checks do template de descrição:
   Reforçar a necessidade de verificar todos os itens do template de descrição do PR antes de submeter. Certificar-se de que todos os requisitos foram atendidos ajuda a garantir que o PR está completo e facilita a revisão.

   Explicar os benefícios:

   • Garantir que o PR esteja em conformidade com o template facilita a revisão e acelera o processo de integração.