diff --git "a/.github/ISSUE_TEMPLATE/nova-funcionalidade-\360\237\214\237.md" "b/.github/ISSUE_TEMPLATE/nova-funcionalidade-\360\237\214\237.md" index 81603be0..e429d5c2 100644 --- "a/.github/ISSUE_TEMPLATE/nova-funcionalidade-\360\237\214\237.md" +++ "b/.github/ISSUE_TEMPLATE/nova-funcionalidade-\360\237\214\237.md" @@ -18,3 +18,13 @@ Uma descrição clara e concisa de quaisquer soluções ou recursos alternativos **Contexto adicional** Adicione qualquer outro contexto ou capturas de tela sobre o pedido de recurso aqui. + +**💌 Quer contribuir, mas não se sente à vontade?** + +Você tem vontade de contribuir, mas não se sente à vontade em abrir issues, PRs ou fazer perguntas publicamente? + +Nós sabemos como pode ser difícil dar o primeiro passo em um espaço aberto. A insegurança, o medo de errar ou até a sensação de “será que minha dúvida é boba?” podem pesar bastante. E tá tudo bem sentir isso. 💜 + +Queremos que você saiba que aqui ninguém precisa enfrentar esse caminho sem apoio. Se preferir um espaço mais reservado, você pode mandar um e-mail para cumbucadev@gmail.com e teremos o maior prazer em ajudar. Seja para tirar dúvidas, pedir orientação ou simplesmente ter alguém para conversar sobre como começar. + +O importante é que você saiba: sua participação é muito bem-vinda, e cada contribuição, por menor que pareça, faz uma grande diferença. ✨ diff --git "a/.github/ISSUE_TEMPLATE/reportar-um-bug-\360\237\220\233.md" "b/.github/ISSUE_TEMPLATE/reportar-um-bug-\360\237\220\233.md" index 933fb164..a961cb8a 100644 --- "a/.github/ISSUE_TEMPLATE/reportar-um-bug-\360\237\220\233.md" +++ "b/.github/ISSUE_TEMPLATE/reportar-um-bug-\360\237\220\233.md" @@ -25,3 +25,13 @@ Uma descrição clara e concisa do que você esperava que acontecesse. **Contexto adicional** Adicione qualquer outro contexto sobre o problema aqui. + +**💌 Quer contribuir, mas não se sente à vontade?** + +Você tem vontade de contribuir, mas não se sente à vontade em abrir issues, PRs ou fazer perguntas publicamente? + +Nós sabemos como pode ser difícil dar o primeiro passo em um espaço aberto. A insegurança, o medo de errar ou até a sensação de “será que minha dúvida é boba?” podem pesar bastante. E tá tudo bem sentir isso. 💜 + +Queremos que você saiba que aqui ninguém precisa enfrentar esse caminho sem apoio. Se preferir um espaço mais reservado, você pode mandar um e-mail para cumbucadev@gmail.com e teremos o maior prazer em ajudar. Seja para tirar dúvidas, pedir orientação ou simplesmente ter alguém para conversar sobre como começar. + +O importante é que você saiba: sua participação é muito bem-vinda, e cada contribuição, por menor que pareça, faz uma grande diferença. ✨ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9c36c275..7507e889 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,6 +5,16 @@ Obrigado por dedicar o seu tempo para contribuir! 🙇‍♀️🙇‍♂️ Tod - [Primeira Contribuição](#primeira-contribuição) - [Lançar uma Nova Versão](#lançar-uma-nova-versão) +## 💌 Quer contribuir, mas não se sente à vontade? + +Você tem vontade de contribuir, mas não se sente à vontade em abrir issues, PRs ou fazer perguntas publicamente? + +Nós sabemos como pode ser difícil dar o primeiro passo em um espaço aberto. A insegurança, o medo de errar ou até a sensação de “será que minha dúvida é boba?” podem pesar bastante. E tá tudo bem sentir isso. 💜 + +Queremos que você saiba que aqui ninguém precisa enfrentar esse caminho sem apoio. Se preferir um espaço mais reservado, você pode mandar um e-mail para cumbucadev@gmail.com e teremos o maior prazer em ajudar. Seja para tirar dúvidas, pedir orientação ou simplesmente ter alguém para conversar sobre como começar. + +O importante é que você saiba: sua participação é muito bem-vinda, e cada contribuição, por menor que pareça, faz uma grande diferença. ✨ + ## Primeira Contribuição Como fazer a sua primeira contribuição: @@ -143,10 +153,7 @@ pip install -r requirements-dev.txt Agora você pode usá-lo [da mesma forma descrita no arquivo README.md](/README.md#utilização). - - - -# Testes +## Testes Execute os testes através do seguinte comando: diff --git a/CONTRIBUTING_EN.md b/CONTRIBUTING_EN.md index f488732a..c0c1c6de 100644 --- a/CONTRIBUTING_EN.md +++ b/CONTRIBUTING_EN.md @@ -5,7 +5,17 @@ Thanks for taking the time to contribute! 🙇‍♀️🙇‍♂️ Every littl - [First Contribution](#first-contribution) - [Release a New Version](#release-a-new-version) -# First Contribution +### 💌 Want to contribute, but don’t feel comfortable? + +Do you feel like contributing but feel uncomfortable opening issues, PRs, or asking questions publicly? + +We know how hard it can be to take the first step in an open space. Insecurity, the fear of making mistakes, or even wondering “is my question silly?” can weigh heavily. And it’s okay to feel that way. 💜 + +We want you to know that no one has to face this journey alone. If you’d prefer a more private space, you can send an email to cumbucadev@gmail.com, and we’ll be happy to help. Whether it’s to clear up doubts, ask for guidance, or simply have someone to talk to about how to get started. + +What matters is that you know: your participation is very welcome, and every contribution, no matter how small it may seem, makes a big difference. ✨ + +## First Contribution How to make your first contribution: @@ -75,9 +85,9 @@ Switched to a new branch '386' ### 7. Run brutils locally -## Installation with poetry +#### Installation with poetry -### Requirements +##### Requirements - [Python 3.10+][python] - [Poetry][poetry] @@ -112,11 +122,11 @@ Installing dependencies from lock file ... ``` -## Installation with pip +#### Installation with pip If you prefer to use pip, you can install the project in development mode as follows: -### Requirements +##### Requirements - [Python 3.10+][python] - [pip][pip] @@ -134,7 +144,7 @@ Use the pip command to install the dev and test dependencies through the require pip install -r requirements-dev.txt ``` -## Using locally +#### Using locally Now, you can use it [in the same way described in the README.md file](/README_EN.md#usage). @@ -584,7 +594,7 @@ This PR adds the convert_uf_to_text utility to convert Brazilian state codes (e. [Ensure your branch is up to date with main][github-sync-pr]. -# Release a New Version +## Release a New Version Here you will find how to deploy a new production version of brutils: