nf-core/modules topics migration
components - UFRN
Este projeto de hackathon tem como foco atualizar módulos do nf-core para usar recursos modernos do Nextflow, especificamente topic channels.
Topic channels simplificam a coleta de versões entre módulos e estão se tornando a abordagem padrão dentro do nf-core.
Recursos:
- Tutorial de migração para topics do nf-core
- Topic channels na documentação do Nextflow
- Topic channels no dashboard de estatísticas de adoção do nf-core
Objetivo
Migrar todos os módulos do nf-core para usar topic channels.
Este trabalho está organizado para que cada participante atualize um módulo por vez, o que o torna uma contribuição amigável para iniciantes.
O que os participantes farão
Cada colaborador irá:
- Escolher um módulo que ainda não tenha sido migrado.
- Atualizá-lo para usar topic channels seguindo as diretrizes oficiais.
- Executar testes e verificações de lint localmente.
- Abrir um Pull Request para revisão.
Cada migração corresponde a uma issue no repositório de módulos.
Tarefas
Migrar um módulo para topic channels
-
Escolha um módulo disponível no rastreador de migração
-
Atribua a issue a você para evitar trabalho duplicado.
-
Siga o guia oficial de migração. Estatísticas aqui.
-
Atualize o módulo:
- Substituindo a lógica legada de coleta de versões
- Usando topic channels para reporte de versões
- Atualizando os testes, se necessário
-
Execute os testes do módulo e as verificações de lint localmente.
-
Abra um Pull Request referenciando a issue de migração.
-
Trate feedback de CI ou de revisão até a mesclagem.
Após concluir, os colaboradores são encorajados a migrar módulos adicionais.
Preparação recomendada
Idealmente, os participantes devem ter:
- Familiaridade básica com Git e GitHub (fazer fork de repositórios, criar branches e abrir pull requests)
- Conhecimento básico de Nextflow
- Familiaridade com módulos nf-core
O seguinte material de treinamento é recomendado:
