Skip to content

🤝 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

  1. Faça um fork deste repositório.
  2. Crie uma branch para sua alteração: ```bash git checkout -b minha-feature
  3. Implemente suas mudanças:
  4. Código (Flask, Python, etc.)
  5. Dashboards e visualizações
  6. Documentação
  7. Melhorias no fluxo de dados

  8. Teste suas alterações antes de enviar.

  9. Commit suas mudanças com uma mensagem clara: ```bash git commit -m "feat: adiciona gráfico comparativo de matrículas por região"
  10. Envie sua branch: ```bash git push origin minha-feature
  11. 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 funcionalidades
  • fix: para correções de bugs
  • docs: para mudanças na documentação
  • refactor: para melhorias internas de código
  • style: 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.