google/benchmark

Document JSON format

Open

#720 opened on Nov 19, 2018

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

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

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.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Look at the code that outputs JSON in the benchmark library, likely in src/ or include/. Identify the exact fields and structure of the JSON. Create a new documentation file under docs/ explaining the JSON format. Reference existing documentation for style. No linked PRs or comments provide additional context.