ljharb/repo-report

Add Example Usage for JSON Output

Open

#70 opened on Mar 3, 2022

View on GitHubContributor guide
 (6 comments) (0 reactions) (0 assignees)JavaScript (17 forks)github user discovery
documentationenhancementgood first issuehelp wanted

Repository metrics

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

Description

Summary

Add Example Usage for JSON Output

Background

Provide an example on the main readme page illustrating how to generate an output report in JSON format.

Tasks

  1. Add example command line usage showing how to generate a JSON report
  2. (Optional) Provide a sample (sanitized) JSON report and store it in this repository (allows consumers to see a working example report)

Acceptance Criteria

  1. Example usage displayed on the main readme page.
  2. (optional) users can view publically accessible example JSON report

Contributor guide

Research direction
Add an example usage section in the README showing how to generate JSON output. Optionally create a sample JSON report file and link it.
Tech stack
javascriptnodejs
Domain
clidocumentation
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
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90