google/benchmark

Document JSON format

Open

#720 opened on Nov 19, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (1,539 forks)batch import
docsgood first issuehelp wanted

Repository metrics

Stars
 (7,968 stars)
PR merge metrics
 (Avg merge 4d 2h) (19 merged PRs in 30d)

Description

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 direction
Examine the current JSON output produced by the benchmark and document its structure.
Tech stack
cpp
Domain
documentation
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JSON
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85