Remove hyphens from pipeline names in Nextflow workflows
Open
Nobody has claimed this yet.
enhancement
good-first-issue
- Dominant language
- Python
- Stars
- 322
- Forks
- 255
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 5
Description
Description of feature
There's a common convention outside of nf-core to call your pipeline nf-${thing}, but in doing this we add a hyphen which is an invalid Nextflow workflow name.
It's an easy fix shortly after creation to remove the hyphen, but we can replace all hyphens with strings while creating the subworkflow names.
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 Python code that creates workflow and subworkflow names, then inspect nearby tests or the relevant test suite. Confirm that names generated from pipeline names containing hyphens are valid and that existing naming behavior remains covered by passing tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100