github/github-artifact-exporter

Increase code commenting

Open

#3 opened on Oct 19, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (22 forks)github user discovery
documentationgood first issuehelp wanted

Repository metrics

Stars
 (280 stars)
PR merge metrics
 (PR metrics pending)

Description

Do this to add clarity for new contributors and good code hygiene. Focus especially on adding comments in the packages/cli/src/commands/* files as they are more sparsely commented.

Contributor guide

Research direction
Identify the command files in packages/cli/src/commands/ and review each to add comments explaining the purpose and logic of key functions and types.
Tech stack
typescript
Domain
cli
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
GitTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80