nf-core / nf-core/tools

Provide novel tooling for regulatory needs

Open
#3,258 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Description of feature

We are currently a group of people working on #regulatory topics and have several needs that we consider to be of value for the wider community. This includes tooling that can create a snapshot / nf-core regulatory report for a certain pipeline that contains information that should be accessible online but needs to be snapshotted:

  • Number of users of that pipeline
  • Number of contributors
  • How many releases per year? How many releases within the last 6 months?
  • How many minor/major releases this year?
  • Link to versioned documentation / user documentation
  • Github stars, clones per time units
  • Review policies set accordingly for branches
  • Changelog of pipeline
  • Utilized containers + software versions (?)
  • pipeline version

(none of this intends to be complete)

Most of this can be done relatively easily, but we think it would be great if e.g. something like:

nf-core pipelines regulatory

exists and then generates already the information snapshot that we will always need, almost independent of the standard we try to tackle.

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

Start by reviewing the proposed nf-core pipelines regulatory command and the listed snapshot fields, including releases, users, contributors, documentation, GitHub metrics, review policies, changelog, containers, and software versions. Define the reporting scope and regulatory standards first; done means an agreed, repeatable snapshot design rather than a partial collection of metrics.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.