nextflow-io / nextflow-io/training
Side quest idea: patching modules
Nobody has claimed this yet.
- Dominant language
- Nextflow
- Stars
- 271
- Forks
- 329
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 11
Description
While the Hello nf-core training provides an excellent introduction to working with modules, I think it would be highly valuable to include a brief side quest covering how to patch a module. Most developers will eventually need to make small custom modifications, and demonstrating the correct patching workflow (to avoid linting failures) would be extremely helpful.
This addition could be a short demo using nf-core modules patch that highlights how modules remain fully modular even after applying custom changes. A simple example (such as the label modification shown in the patch documentation: https://nf-co.re/docs/nf-core-tools/modules/patch) could be sufficient but this can certainly be extended as well.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Hello nf-core training material and review the nf-core modules patch documentation linked in the issue. Add a brief side quest using nf-core modules patch, with a simple label-modification example and guidance on avoiding linting failures. Done means learners can follow the workflow and understand that patched modules remain modular.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100