google/benchmark

Document JSON format

Open

#720 aperta il 19 nov 2018

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)C++ (1539 fork)batch import
docsgood first issuehelp wanted

Metriche repository

Star
 (7968 star)
Metriche merge PR
 (Merge medio 4g 2h) (19 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina il codice nella libreria benchmark che produce output JSON, probabilmente in src/ o include/. Identifica i campi esatti e la struttura del JSON. Crea un nuovo file di documentazione in docs/ che spieghi il formato JSON. Fai riferimento alla documentazione esistente per lo stile. Nessun PR o commento collegato fornisce contesto aggiuntivo.
Tech stack
cpp
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JSON
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85