Add badge to pipeline readme template that dynamically shows if pipeline official or not
Nobody has claimed this yet.
- 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.
Implementation
I don't have a specific suggestion, but there are lots of different services online:
- https://github.com/marketplace/actions/dynamic-badges
- https://dynamic-badge-formatter.demolab.com/
- https://css-tricks.com/adding-custom-github-badges-to-your-repo/
Otherwise @ewels and @mashehu had suggestions here:
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
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