Skip to content
MercoDocs

Como Contribuir

Existem múltiplos caminhos para colaborar com o MercoDocs, desde melhorias de código até a curadoria de dados e validação de documentos.

Áreas de Contribuição

Section titled “Áreas de Contribuição”

1. Contribuições Além do Código

Section titled “1. Contribuições Além do Código”

São contribuições fundamentais para o amadurecimento e a disseminação do projeto na comunidade acadêmica:

  • Teste de Documentação e Usabilidade: Ler os manuais deste site, executar o passo a passo e apontar onde as instruções ficaram confusas, incompletas ou com comandos quebrados.
  • Indicação e Curadoria de Revistas: Sugerir novos periódicos de acesso aberto para serem mapeados no arquivo config/journals.json, indicando o portal OJS ou SciELO correspondente.
  • Validação da Qualidade dos Metadados: Inspecionar as coletas geradas e reportar falhas como resumos cortados, DOIs incorretos ou links inválidos de PDFs.
  • Divulgação e Disseminação: Compartilhar o projeto em grupos de pesquisa, laboratórios, eventos acadêmicos e citar a plataforma em trabalhos e artigos científicos.
  • Sugestão de Funcionalidades: Abrir discussões com novas ideias de filtros, formatos de exportação ou análises úteis para pesquisadores.

2. Contribuições em Código e Engenharia de Dados

Section titled “2. Contribuições em Código e Engenharia de Dados”

Para quem deseja atuar diretamente no desenvolvimento de software e infraestrutura:

  • Desenvolvimento de Spiders: Criar e aprimorar rotinas de coleta em Scrapy e Playwright para novas plataformas e layouts de periódicos.
  • Melhorias no Website: Contribuir com a documentação em Astro e Starlight, corrigindo textos, ajustando estilos ou criando novos componentes.
  • Avanço no Roadmap Técnico: Apoiar a implementação do coletor via protocolo OAI-PMH, injeção de metadados XMP em PDFs e integração com o Recoll.
  • Cobertura de Testes: Escrever testes unitários adicionais utilizando o Pytest para garantir a estabilidade das extrações.
  • Otimização de Pipelines: Aprimorar o consumo de memória, paralelismo e persistência dos dados no TinyDB.

Fluxo Básico para Iniciar

Section titled “Fluxo Básico para Iniciar”
  1. Escolha ou abra uma Issue: Antes de começar a produzir uma alteração grande, verifique as Issues abertas no repositório ou crie uma nova descrevendo sua proposta.
  2. Converse com a equipe: Alinhe os detalhes da tarefa com os mantenedores nos comentários da Issue.
  3. Siga os padrões do projeto: