nf-core / nf-core/references

Enhance documentation

Open
#18 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
Nextflow
Stars
23
Forks
6
Avg merge
1d 9h
Merged PRs (30d)
6

Description

Add proper documentation to explain how to properly use it and implement it in the pipelines

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 files, tests, or entry points are named. Start by reviewing the repository's existing pipeline usage and implementation material, then document how to use the references pipeline and how to implement it in pipelines; done means the intended workflow is explained clearly.

Written by the indexing model from the issue text.

Assessment

Domain
bioinformatics, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.