From d132381d9f6ee7079e0e1d094b449a0200125b90 Mon Sep 17 00:00:00 2001 From: DanielRogs Date: Wed, 24 Sep 2025 01:07:53 -0300 Subject: [PATCH] feat: adiciona novos issue template e documentacao --- .github/ISSUE_TEMPLATE/README.md | 19 ++++++++ .github/ISSUE_TEMPLATE/documentacao.md | 64 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/nova-feature.md | 49 ++++++++++++++++++++ 3 files changed, 132 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/documentacao.md create mode 100644 .github/ISSUE_TEMPLATE/nova-feature.md diff --git a/.github/ISSUE_TEMPLATE/README.md b/.github/ISSUE_TEMPLATE/README.md index 0c129c4..e10ca95 100644 --- a/.github/ISSUE_TEMPLATE/README.md +++ b/.github/ISSUE_TEMPLATE/README.md @@ -29,6 +29,25 @@ Use este template para reportar bugs e problemas encontrados no projeto. - Problemas de configuração - Comportamento inesperado +### 📚 [Proposta de Documentação](documentacao.md) +Use este template quando quiser propor melhorias, correções ou criar nova documentação para o projeto. + +**Quando usar:** +- Documentação existente está desatualizada ou incorreta +- Precisa criar nova documentação ou tutorial +- Quer melhorar a clareza ou completude da documentação +- Identificou lacunas na documentação atual + +### ✨ [Nova Funcionalidade](nova-feature.md) +Use este template quando quiser propor uma nova funcionalidade que não envolve adaptação ou criação de scrapers. + +**Quando usar:** +- Quer propor melhorias na arquitetura do sistema +- Precisa de nova integração com ferramenta ou API +- Quer adicionar funcionalidades auxiliares (logging, monitoramento, etc.) +- Propor melhorias na interface web ou API +- Sugerir novos testes ou validações + ## 📚 Antes de Contribuir 1. **Leia os tutoriais**: diff --git a/.github/ISSUE_TEMPLATE/documentacao.md b/.github/ISSUE_TEMPLATE/documentacao.md new file mode 100644 index 0000000..a754d58 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentacao.md @@ -0,0 +1,64 @@ +--- +name: 📚 Proposta de Documentação +about: Abra uma issue para propor, solicitar mudanças na documentação do projeto. +title: '[DOCS]: [RESUMO DA SUA PROPOSTA]' +labels: '' +assignees: '' + +--- + +## 📚 Tipo de Documentação + +- [ ] 📝 Correção de documentação existente +- [ ] ✨ Nova documentação +- [ ] 🔄 Atualização de documentação desatualizada +- [ ] 📖 Melhoria de tutorial existente +- [ ] 🎯 Novo tutorial ou guia + +## 📋 Descrição + +[Descreva claramente a documentação que você irá criar, corrigir ou atualizar. Explique o que é, o propósito e o que ela aborda.] + +## 📍 Localização + +**Arquivo(s) afetado(s):** +- [ ] README.md +- [ ] CONTRIBUTING.md +- [ ] Documentação de código (docstrings) +- [ ] Comentários no código +- [ ] Outro: (especifique) + +## 🎯 Objetivo + +[Qual o objetivo principal desta documentação? Qual problema ela resolve ou qual necessidade ela atende?] + +**Público-alvo:** +- [ ] Novos contribuidores +- [ ] Desenvolvedores experientes +- [ ] Usuários finais +- [ ] Mantenedores do projeto + +## 📝 Conteúdo Proposto + +[Forneça um esboço ou um resumo do conteúdo que será adicionado. Use tópicos para organizar as ideias.] + +## 🔗 Referências + +[Adicione links para artigos, documentação externa, ou exemplos que sirvam de referência para a sua proposta.] + +## ✅ Critérios de Aceitação + +- [ ] Documentação está clara e fácil de entender +- [ ] Exemplos práticos incluídos (quando aplicável) +- [ ] Linguagem consistente com o resto da documentação +- [ ] Links funcionais e atualizados +- [ ] Formatação adequada (Markdown) +- [ ] Revisão ortográfica e gramatical + +## 🚀 Impacto Esperado + +[Descreva os benefícios esperados desta documentação para a comunidade ou para o projeto.] + +## 📚 Informações Adicionais + +[Adicione qualquer observação extra, contexto ou detalhes que possam ser úteis.] \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/nova-feature.md b/.github/ISSUE_TEMPLATE/nova-feature.md new file mode 100644 index 0000000..266594e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/nova-feature.md @@ -0,0 +1,49 @@ +--- +name: ✨ Proposta de Nova Funcionalidade +about: Proponha uma nova funcionalidade para o projeto +title: '[FEAT]: [NOVA FUNCIONALIDADE]' +labels: '' +assignees: '' + +--- + +## ✨ Tipo de Proposta + +- [ ] 🗣️ Nova funcionalidade +- [ ] 📈 Melhoria em funcionalidade existente +- [ ] ⚙️ Alteração na arquitetura +- [ ] 🧪 Proposta de novo teste ou validação +- [ ] 📦 Integração com nova ferramenta ou API + +## 📋 Descrição do Problema + +[Descreva de forma clara e concisa o problema que a nova funcionalidade resolveria. Por que essa funcionalidade é necessária?] + +## 💡 Proposta de Solução + +[Descreva como a nova funcionalidade resolveria o problema. Inclua detalhes sobre o comportamento esperado e as possíveis interações com outras partes do projeto.] + +## 🚀 Impacto Esperado + +- [ ] Melhoria na experiência do usuário +- [ ] Aumento de desempenho +- [ ] Redução de complexidade no código +- [ ] Adição de novas capacidades +- [ ] Outro (especifique) + +[Descreva em mais detalhes os benefícios dessa funcionalidade para o projeto e para os usuários. Por que ela é importante agora?] + +## 🎨 Design / Mockups (Opcional) + +[Se aplicável, adicione wireframes, mockups, ou qualquer representação visual da funcionalidade para ajudar a ilustrar a ideia.] + +## ✅ Critérios de Aceitação + +- [ ] A funcionalidade atende ao propósito descrito. +- [ ] O código é escalável e fácil de manter. +- [ ] A funcionalidade é coberta por testes (se aplicável). +- [ ] A documentação é atualizada para refletir a nova funcionalidade. + +## 📚 Informações Adicionais + +[Adicione qualquer informação extra que possa ser útil, como referências, links, ou exemplos de uso.] \ No newline at end of file