Add nf-schema comment to the plugin import and sample sheet channel generation
Open
Nobody has claimed this yet.
good-first-issue
schema
template
- Dominant language
- Python
- Stars
- 322
- Forks
- 255
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 5
Description
Description of feature
I am creating a new pipeline and just became aware of nf-schema (https://nextflow-io.github.io/nf-schema/latest/). The suggestion has come up to add a code comment above the plugin import and sample sheet channel generation with links to the nf-schema documentation website so that people become aware of it.
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
Locate the plugin import and sample sheet channel generation referenced in the issue. Read the nf-schema documentation at https://nextflow-io.github.io/nf-schema/latest/ and add comments linking to it above both locations; done means users can discover nf-schema from the generated pipeline code.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100