🤝 Guia de Contribuição
Obrigado por querer contribuir com o InfoSchool! 🚀
Este projeto tem como objetivo tornar os microdados do Censo Escolar mais acessíveis, através de:
- Dashboards interativos e comparativos
- Enriquecimento e padronização dos metadados
- Interface conversacional com RAG (Retrieval-Augmented Generation) para consultas inteligentes
- Acesso simplificado às informações da educação básica no Brasil
Sua contribuição é muito bem-vinda para tornar este projeto mais robusto, útil e acessível para todos.
📌 Como Contribuir
- Faça um fork deste repositório.
- Crie uma branch para sua alteração: ```bash git checkout -b minha-feature
- Implemente suas mudanças:
- Código (Flask, Python, etc.)
- Dashboards e visualizações
- Documentação
-
Melhorias no fluxo de dados
-
Teste suas alterações antes de enviar.
- Commit suas mudanças com uma mensagem clara: ```bash git commit -m "feat: adiciona gráfico comparativo de matrículas por região"
- Envie sua branch: ```bash git push origin minha-feature
- Abra um Pull Request explicando o que foi feito.
✅ Boas Práticas
- Utilize Python (Flask) e siga a arquitetura definida no projeto.
- Para dashboards, mantenha gráficos claros, informativos e comparativos úteis.
- Documente suas mudanças no código e, se necessário, atualize o README.
- Sempre que possível, adicione testes automatizados.
- Utilize mensagens de commit no padrão:
feat: para novas funcionalidadesfix: para correções de bugsdocs: para mudanças na documentaçãorefactor: para melhorias internas de códigostyle: para ajustes de formatação
🐛 Reportando Problemas
Se encontrar bugs, inconsistências ou tiver sugestões de melhorias: 1. Abra uma issue descrevendo o problema ou sugestão. 2. Inclua: - Passos para reproduzir - Exemplos de entrada/saída - Prints ou logs (se aplicável)
🎯 Áreas de Contribuição
Você pode contribuir de várias formas: - Integração de dados: novas formas de tratar, limpar e enriquecer os microdados. - Dashboards: criação de gráficos comparativos, análises por escola, região e ano. - Interface RAG: melhorias na busca conversacional e recuperação de informações. - Documentação: guias de uso, exemplos de consultas, tutoriais. - Performance: otimizações em consultas, carregamento de dados e arquitetura.