(#474) - Adiciona melhores práticas de título e descrição de RP aos arquivos CONTRIBUTING (#530)

* Atualizar a seção 13 - Crie um PR em Ingles

* Atualizar a seção 13 - Crie um PR em Portugues

* Update CONTRIBUTING.md

Co-authored-by: Camila Maia <cmaiacd@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Camila Maia <cmaiacd@gmail.com>

* Adicionando melhores exemplos checklist

* Update CONTRIBUTING_EN.md

* Pequenos detalhes no CONTRIBUTING.md

* Pequenos detalhes CONTRIBUTING_EN.md

---------

Co-authored-by: Camila Maia <cmaiacd@gmail.com>

Author: laistdomiciano

CONTRIBUTING.md

@@ -580,7 +580,45 @@ _Este conteúdo é baseado no [site do keep a changelog][keep-a-changelog], já
 
 ### 13. Crie um PR no GitHub
 
-[Crie um PR no GitHub][github-creating-a-pr].
+[Crie um PR no GitHub][github-creating-a-pr] para enviar suas alterações para revisão. Para garantir que seu Pull Request (PR) seja claro, eficaz e revisado rapidamente, siga estas boas práticas:
+
+#### Escreva um Título Descritivo para o PR
+- Use títulos claros e específicos para descrever o propósito das suas alterações. Um bom título ajuda às pessoas mantenedoras a entender a intenção do PR rapidamente e melhora a rastreabilidade do projeto.
+- **Exemplo**: Em vez de “Corrigir problema”, use “Adiciona utilitário `convert_uf_to_text` para lidar com códigos de estados brasileiros.”
+- **Benefícios**:
+  - Títulos claros facilitam a priorização e o entendimento pelos revisores.
+  - Melhoram a organização e a busca no projeto.
+
+#### Forneça uma Descrição Detalhada do PR
+- Inclua uma descrição completa no seu PR para explicar:
+  - **O que** foi feito (ex.: adicionou uma nova função, corrigiu um bug).
+  - **Por que** foi feito (ex.: para resolver uma issue específica ou melhorar o desempenho).
+  - **Quais problemas** foram resolvidos ou melhorias aplicadas (ex.: referencie a issue ou descreva a melhoria).
+- **Exemplo**:
+Este PR adiciona o utilitário convert_uf_to_text para converter códigos de estados brasileiros (ex.: “SP”) em nomes completos (ex.: “São Paulo”). Resolve a issue #474, melhorando a reutilização de código para formatação de endereços. A função inclui validação de entrada e testes atualizados.
+- **Benefícios**:
+- Descrições detalhadas agilizam o processo de revisão ao fornecer contexto.
+- Ajudam futuros mantenedores a entender o propósito e o histórico do código.
+
+#### Vincule o PR à Issue Relacionada
+- Referencie a issue que seu PR resolve usando palavras-chave como `Closes #474` ou `Fixes #474` na descrição do PR. Isso fecha a issue automaticamente quando o PR for mesclado.
+- **Exemplo**: `Closes #474`
+- **Benefícios**:
+- Vincular issues mantém o repositório organizado e garante o rastreamento de tarefas.
+- Automatiza o fechamento de issues, reduzindo trabalho manual para mantenedores.
+- Para mais detalhes, consulte a [documentação do GitHub sobre fechamento automático de issues](https://docs.github.com/pt/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
+
+#### Verifique o Template de Descrição do PR
+- Certifique-se de que seu PR segue o template de descrição do repositório. Verifique todos os itens obrigatórios, como cobertura de testes, atualizações de documentação ou entradas no changelog.
+- **Exemplo de Checklist**: (mostrando como fica quando preenchido):
+- [x] Alterações no código foram testadas.
+- [x] Documentação (READMEs) foi atualizada.
+- [ ] Entrada no changelog foi adicionada (marque apenas se aplicável).
+- **Nota sobre a Sintaxe**:
+- Use [x] para marcar itens concluídos e [ ] para itens não concluídos, sem espaços dentro dos colchetes (ex.: [ x ] ou [x ] não será renderizado corretamente no GitHub).
+- **Benefícios**:
+- Seguir o template garante que o PR esteja completo e pronto para revisão.
+- Reduz a necessidade de idas e vindas com revisores, acelerando o processo de mesclagem.
 
 ### 14. Atualizar a Sua Branch se Necessário
 

CONTRIBUTING_EN.md

@@ -19,10 +19,10 @@ How to make your first contribution:
 - [8. Make your Changes](#8-make-your-changes)
 - [9. Test your Changes](#9-test-your-changes)
 - [10. Update READMEs](#10-update-readmes)
-- [11. Commit and push your Changes](#10-commit-and-push-your-changes)
-- [12. Add changelog Entries](#11-add-changelog-entries)
-- [13. Create a GitHub PR](#12-create-a-github-pr)
-- [14. Update your branch if Needed.](#13-update-your-branch-if-needed)
+- [11. Commit and push your Changes](#11-commit-and-push-your-changes)
+- [12. Add changelog Entries](#12-add-changelog-entries)
+- [13. Create a GitHub PR](#13-create-a-github-pr)
+- [14. Update your branch if Needed.](#14-update-your-branch-if-needed)
 
 ### 1. Create a GitHub Account
 
@@ -540,7 +540,45 @@ This content is based on the [Keep a Changelog][keep-a-changelog] site, as we fo
 
 ### 13. Create a GitHub PR
 
-[Create a GitHub PR][github-creating-a-pr].
+[Create a GitHub PR][github-creating-a-pr] to submit your changes for review. To ensure your Pull Request (PR) is clear, effective, and reviewed quickly, follow these best practices:
+
+#### Write a Descriptive PR Title
+- Use clear and specific titles to describe the purpose of your changes. A good title helps maintainers understand the PR’s intent at a glance and improves project traceability.
+- **Example**: Instead of “Fix issue,” use “Add utility `convert_uf_to_text` to handle Brazilian state codes.”
+- **Benefits**:
+  - Clear titles make it easier for reviewers to prioritize and understand the PR.
+  - They improve the project’s organization and searchability.
+
+#### Provide a Detailed PR Description
+- Include a comprehensive description in your PR to explain:
+  - **What** was done (e.g., added a new function, fixed a bug).
+  - **Why** it was done (e.g., to address a specific issue or improve performance).
+  - **What issues** were resolved or improvements applied (e.g., link to the issue or describe the enhancement).
+- **Example**:
+This PR adds the convert_uf_to_text utility to convert Brazilian state codes (e.g., "SP") to full state names (e.g., "São Paulo"). It addresses issue #474 by improving code reusability for address formatting. The function includes input validation and updated tests.
+- **Benefits**:
+- Detailed descriptions speed up the review process by providing context.
+- They help future maintainers understand the code’s purpose and history.
+
+#### Link the PR to the Related Issue
+- Reference the issue your PR addresses using keywords like `Closes #474` or `Fixes #474` in the PR description. This automatically closes the issue when the PR is merged.
+- **Example**: `Closes #474`
+- **Benefits**:
+- Linking issues keeps the repository organized and ensures tasks are tracked.
+- It automates issue closure, reducing manual work for maintainers.
+- For more details, see the [GitHub documentation on closing issues automatically](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
+
+#### Verify the PR Description Template
+- Ensure your PR follows the repository’s PR description template (if provided). Check all required items, such as test coverage, documentation updates, or changelog entries.
+- **Example Checklist**: (showing how it looks when completed):
+- [x] Code changes are tested.
+- [x] Documentation (READMEs) is updated.
+- [ ] Changelog entry is added.
+- **Syntax Note**:
+- Use [x] to mark completed items and [ ] for incomplete ones, with no spaces inside the brackets (e.g., [ x ] or [x ] will not render correctly on GitHub).
+- **Benefits**:
+- Adhering to the template ensures your PR is complete and ready for review.
+- It reduces back-and-forth with reviewers, speeding up the merge process.
 
 ### 14. Update your branch if needed.