nf-core/modules new modules
components - UFRN
Este projeto de hackathon tem como foco criar novos módulos no nf-core/modules, seguindo os padrões oficiais da comunidade nf-core.
A criação de módulos amplia a cobertura de ferramentas reutilizáveis, facilita a manutenção de pipelines e fortalece o ecossistema colaborativo do nf-core.
Recursos:
Objetivo
Criar novos módulos no nf-core/modules com testes, documentação e lint em conformidade com os padrões do projeto.
Este trabalho está organizado para que cada participante implemente um módulo por vez, tornando a contribuição acessÃvel para iniciantes.
O que os participantes farão
Cada colaborador irá:
- Escolher uma ferramenta que ainda não possua módulo no repositório.
- Verificar se já existe issue aberta para essa ferramenta.
- Criar o módulo seguindo o template e as diretrizes do nf-core.
- Adicionar testes, metadados e documentação.
- Executar lint e testes localmente.
- Abrir um Pull Request para revisão.
Cada novo módulo deve estar vinculado a uma issue no repositório.
Tarefas
Criar um novo módulo no nf-core/modules
-
Escolha uma ferramenta de bioinformática que ainda não tenha módulo no nf-core/modules.
-
Abra uma issue (ou assuma uma issue existente) para evitar trabalho duplicado.
-
Siga as diretrizes do guia oficial de contribuição de módulos.
-
Implemente o módulo incluindo:
- Script/module file com entradas e saÃdas padronizadas
- Metadados e documentação de uso
- Testes mÃnimos para validação funcional
-
Rode os comandos de lint e testes localmente.
-
Abra um Pull Request referenciando a issue correspondente.
-
Trate feedback de CI e revisão até a mesclagem.
Após concluir, os colaboradores são encorajados a criar módulos adicionais.
Preparação recomendada
Idealmente, os participantes devem ter:
- Familiaridade básica com Git e GitHub (fork, branch e pull request)
- Conhecimento básico de Nextflow
- Familiaridade com estruturas do nf-core/modules
O seguinte material de treinamento é recomendado:
