This hackathon project focuses on updating nf-core/modules to use modern Nextflow features, specifically topic channels.
Topic channels simplify version collection across modules, and are becoming the standard approach within nf-core.
Resources:
- nf-core migration to topics tutorial
- Topic channels in Nextflow documentation
- Topic channnels in nf-core adoption statistics dashboard
Goal
Migrate all nf-core modules to use topic channels.
This work is organized so each participant updates one module at a time, making it suitable as a beginner-friendly contribution.
What participants will do
Each contributor will:
- Pick one module that has not yet been migrated.
- Update it to use topic channels following official guidelines.
- Run tests and lint checks locally.
- Open a Pull Request for review.
Each migration corresponds to one issue in the modules repository.
Tasks
Migrate a module to topic channels
-
Choose an available module from the migration tracker
-
Assign the issue to yourself to avoid duplicate work.
-
Follow the official migration guide
-
Update the module by:
- Replacing legacy version collection logic
- Using topic channels for version reporting
- Updating tests if necessary
-
Run module tests and lint checks locally.
-
Open a Pull Request referencing the migration issue.
-
Address CI or review feedback until merged.
After finishing, contributors are encouraged to migrate additional modules.
Recommended preparation
Participants should ideally have:
- Basic familiarity with Git and GitHub (forking repositories, creating branches, and opening pull requests)
- Basic knowledge of Nextflow
- Familiarity with nf-core modules
The following training material is recommended: