nf-core / nf-core/website

[Regulatory] Provide Guideline for running validation on top of nf-core reports

Open
#3,605 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

Guideline should only point users to their own respective institutional requirements, with some pointers on potential things to consider - will never be complete / cover all aspects.

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 nf-core reports documentation and the institutional requirements the guideline should defer to. Done means a guideline that offers limited pointers and considerations for validation while clearly stating that requirements are institution-specific and the guidance is not complete.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
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.