From 1ef52bac2b0073a8c96c10121b4fd07544fecbe3 Mon Sep 17 00:00:00 2001 From: silvia-serpa <73546252+silvia-serpa@users.noreply.github.com> Date: Wed, 12 Aug 2026 15:34:06 +0100 Subject: [PATCH 1/2] =?UTF-8?q?melhoria=20no=20README=20do=20diret=C3=B3ri?= =?UTF-8?q?o=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/README.md b/docs/README.md index 7effa5b437d..542afbd352c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,6 +7,17 @@ ## Sobre o Projeto Página desenvolvida para fins didáticos para o curso **Contribuindo em um Projeto Open Source no GitHub** da [Digital Innovation One](https://www.dio.me/). Lembre-se de que Markdown é mais voltado para a documentação e apresentação de texto formatado, enquanto a remoção de bugs normalmente envolve a compreensão detalhada do código e o uso de ferramentas de desenvolvimento adequadas à linguagem de programação específica. +🧭 **Boas Práticas de Documentação** + +Ao contribuir, não esqueça de: +- Usar títulos claros e objetivos; +- Optar por frases curtas e diretas; +- Explicar o "porquê", não apenas o "como"; +- Manter exemplos simples e funcionais; +- Adaptar os termos tendo em conta o público iniciante; + +**Documentação também é código! Mantenha consistência e organização.** + [![Preview](https://img.shields.io/badge/Preview-000?style=for-the-badge&logo=github&logoColor=30A3DC)](https://digitalinnovationone.github.io/dio-lab-open-source/) ``` From 360271b474116455ca5b2be2331966eae16cacd9 Mon Sep 17 00:00:00 2001 From: silvia-serpa <73546252+silvia-serpa@users.noreply.github.com> Date: Wed, 12 Aug 2026 15:38:33 +0100 Subject: [PATCH 2/2] =?UTF-8?q?melhoria=20no=20README=20do=20diret=C3=B3ri?= =?UTF-8?q?o=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 542afbd352c..757e4026e3c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ Profiles README DIO -## Sobre o Projeto +## Sobre o Projeto Página desenvolvida para fins didáticos para o curso **Contribuindo em um Projeto Open Source no GitHub** da [Digital Innovation One](https://www.dio.me/). Lembre-se de que Markdown é mais voltado para a documentação e apresentação de texto formatado, enquanto a remoção de bugs normalmente envolve a compreensão detalhada do código e o uso de ferramentas de desenvolvimento adequadas à linguagem de programação específica. 🧭 **Boas Práticas de Documentação**