nf-core / nf-core/tools

Pipelines create: Add explicit opt-in for pipeline proposals

Open
#3,857 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

template
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

Description of feature

We're getting a lot of pipelines that are being presented as nf-core but are not. Presumably folks thinking that using the nf-core template = being an nf-core pipeline.

To try to make this even more explicit, in the TUI we should have a page saying "have you put in a pipeline proposal and had it accepted" before defaulting to the nf-core style. Otherwise, default to slim and have everything opt in. Maybe have an escape route for people but make it very explicit that a pipeline proposal is required to make an nf-core pipeline.

For the CLI add a new flag that must be specified in order to use the full nf-core template, amounting to the same thing.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the TUI pipeline-creation page and the CLI pipeline-creation command first. Trace how template selection currently defaults, then define completion as requiring explicit opt-in for the full nf-core template and otherwise selecting the slim template in both interfaces.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.