nf-core / nf-core/website

[Regulatory] Write down security aspects of using nf-core pipelines

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

Nobody has claimed this yet.

enhancement
Dominant language
MDX
Stars
98
Forks
298
Avg merge
14h 38m
Merged PRs (30d)
38

Description

Should write down some aspects on potential impllications that running nf-core pipelines could have, this includes.

  • Container security scanning (CVE handling, patching etc pp) - what is done on nf-core level vs what is on the user / institution running nf-core pipelines
  • Safeguards for code scanning - entering malicious code into nf-core pipelines: Guidelines, documentation, reivew and testing schemes for modules

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 existing nf-core website guidance and identify where security documentation for pipelines belongs. Cover container security scanning, CVE handling and patching responsibilities, then document safeguards against malicious code through guidelines, review and testing schemes; done means the nf-core and user or institution responsibilities are clearly separated.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, security
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.