google/benchmark

Document JSON format

Open

#720 创建于 2018年11月19日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)C++ (7,968 star) (1,539 fork)batch import
docsgood first issuehelp wanted

描述

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.

贡献者指南

技术栈
cpp
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
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.