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:


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:

  1. Pick one module that has not yet been migrated.
  2. Update it to use topic channels following official guidelines.
  3. Run tests and lint checks locally.
  4. Open a Pull Request for review.

Each migration corresponds to one issue in the modules repository.


Tasks

Migrate a module to topic channels

  1. Choose an available module from the migration tracker

  2. Assign the issue to yourself to avoid duplicate work.

  3. Follow the official migration guide

  4. Update the module by:

    • Replacing legacy version collection logic
    • Using topic channels for version reporting
    • Updating tests if necessary
  5. Run module tests and lint checks locally.

  6. Open a Pull Request referencing the migration issue.

  7. Address CI or review feedback until merged.

After finishing, contributors are encouraged to migrate additional modules.


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:


introduction video
Play
location
online
category
components