Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/documentacao.md
Original file line number Diff line number Diff line change
@@ -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.]
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/nova-feature.md
Original file line number Diff line number Diff line change
@@ -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.]