google/benchmark

Document JSON format

Open

#720 geöffnet am 19. Nov. 2018

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (1.539 Forks)batch import
docsgood first issuehelp wanted

Repository-Metriken

Stars
 (7.968 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 4T 2h) (19 gemergte PRs in 30 T)

Beschreibung

Currently we don't provide any documentation as to the format of the JSON we produce. Instead of requiring users to read the code, we should document and then stick to a format for our JSON.

Contributor Guide

Research-Richtung
Betrachten Sie den Code in der Benchmark Bibliothek, der JSON ausgibt, wahrscheinlich in src/ oder include/. Identifizieren Sie die genauen Felder und die Struktur des JSON. Erstellen Sie eine neue Dokumentationsdatei unter docs/, die das JSON Format erklärt. Beziehen Sie sich auf vorhandene Dokumentation für den Stil. Verknüpfte PRs oder Kommentare bieten keinen zusätzlichen Kontext.
Tech Stack
cpp
Domain
documentation
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.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JSON
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85