google/benchmark

Document JSON format

Open

#720 ouverte le 19 nov. 2018

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)C++ (1 539 forks)batch import
docsgood first issuehelp wanted

Métriques du dépôt

Stars
 (7 968 stars)
Métriques de merge PR
 (Merge moyen 4j 2h) (19 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Examinez le code dans la bibliothèque benchmark qui génère la sortie JSON, probablement dans src/ ou include/. Identifiez les champs exacts et la structure du JSON. Créez un nouveau fichier de documentation sous docs/ expliquant le format JSON. Référez vous à la documentation existante pour le style. Aucune PR ou commentaire lié ne fournit de contexte supplémentaire.
Stack technique
cpp
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JSON
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85