ljharb/repo-report

improve documentation

Open

#68 opened on Mar 2, 2022

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)JavaScript (17 forks)github user discovery
documentationhelp wanted

Repository metrics

Stars
 (26 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

We need a better readme that shows example output, and explains the green checks and red x's.

Contributor guide

Research direction
Update the README to include example output and explanations for green checks and red x's.
Tech stack
javascript
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90