ljharb/repo-report

Add Example Usage for JSON Output

Open

#70 geöffnet am 3. März 2022

Auf GitHub ansehen
 (6 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (17 Forks)github user discovery
documentationenhancementgood first issuehelp wanted

Repository-Metriken

Stars
 (25 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Fügen Sie im README einen Beispielabschnitt hinzu, der zeigt, wie eine JSON Ausgabe generiert wird. Optional erstellen Sie eine Beispiel JSON Berichtsdatei und verlinken Sie sie.
Tech Stack
javascriptnodejs
Domain
clidocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90