nf-modules-hub/tb-profiler

Add code-documentation

Open

#1 opened on Jul 18, 2020

View on GitHub
 (2 comments) (0 reactions) (1 assignee)Nextflow (1 fork)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (No merged PRs in 30d)

Description

@sharma-shruti , I've finalized this pipeline. There are some other constructs which I've used - it'd be great if you could please add the code-documentation on this one.

P.S. This would help getting in the habit of reading code.

Contributor guide

Research direction
Read the existing Nextflow pipeline code and add comments explaining each process and function. Start with the main script main.nf.
Tech stack
None
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85