google/benchmark

Document JSON format

Open

#720 aberto em 19 de nov. de 2018

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (1.539 forks)batch import
docsgood first issuehelp wanted

Métricas do repositório

Stars
 (7.968 stars)
Métricas de merge de PR
 (Mesclagem média 4d 2h) (19 fundiu PRs em 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.

Guia do colaborador

Direção de pesquisa
Examine o código na biblioteca benchmark que gera saída JSON, provavelmente em src/ ou include/. Identifique os campos exatos e a estrutura do JSON. Crie um novo arquivo de documentação em docs/ explicando o formato JSON. Consulte a documentação existente para o estilo. Nenhum PR ou comentário vinculado fornece contexto adicional.
Pilha de tecnologia
cpp
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JSON
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85