nf-core / nf-core/tools

Add badge to pipeline readme template that dynamically shows if pipeline official or not

Open
#3,739 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Description of feature

Background

As nf-core is so popular, many developers are using the nf-core template for their own pipelines.

Despite the more recent customisation options with nf-core pipelines create, many people still opt for the fully fledged template with nf-core branding (in some cases because they are considering proposing adding to nf-core after it's finished).

This can lead to confusion for the wider user-community when they come across a pipeline that has the nf-core branding, with an nf-core logo, but then cannot find the pipeline (nor it's documentation) on the website nor on slack.

Propose

I suggest we have a markdown-badge on the template, that (somehow) dynamically detects whether the repo the badge is on, is from an official accepted nf-core pipeline or not.

Static Badge

Static Badge

Implementation

I don't have a specific suggestion, but there are lots of different services online:

Otherwise @ewels and @mashehu had suggestions here:

https://nfcore.slack.com/archives/C072TAN9RDE/p1756671866369489?thread_ts=1756632805.240339&cid=C072TAN9RDE

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

No specific file, test, or implementation entry point is named. Start by locating the nf-core pipeline README template and reviewing how official pipelines are identified; define a reliable badge mechanism and verify it distinguishes accepted nf-core pipelines from other repositories without misleading users.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.