ThinkR-open/inca3

Pimp the documentation

Offen

#7 geöffnet am 30.11.2020

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)R (0 Forks)auto 404
documentationgood first issuehacktoberfest-accepted

Repository-Metriken

Stars
 (5 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

It's currently hard to navigate through the various dataset:

  • Help pages are not informative: column with types doesn't help understanding what they mean, and description + usage doesn't inform about the content of the dataset

Screenshot 2020-11-30 at 09 54 47

  • Home page just displays the name of the dataset

Screenshot 2020-11-30 at 09 55 58

Given that a lot of these are described in the Vignette, I suggest we reuse these information inside the dataset documentation?

Contributor Guide

Research-Richtung
Untersuchen Sie die Vignetten und extrahieren Sie beschreibenden Text für jeden Datensatz. Integrieren Sie diese Informationen dann in die Dokumentationsdateien des Datensatzes (z. B. mit roxygen2), um klarere Hilfeseiten und eine informativere Startseite zu erhalten.
Tech Stack
r
Domain
documentationdata
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Rroxygen2
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70