ChartsOrg/Charts

Create documentation

Open

#4.386 geöffnet am 4. Juni 2020

Auf GitHub ansehen
 (1 Kommentar) (2 Reaktionen) (0 zugewiesene Personen)Swift (6.009 Forks)batch import
help wanted

Repository-Metriken

Stars
 (28.002 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

This project has evolved enough to deserve its own documentation. There is no documentation to do many things that are advertised like combined charts etc. Also, there are readonly properties that are not in the Android project this library was inspired on. This project needs documentation.

Contributor Guide

Research-Richtung
Konzentriere dich auf die 'Kombinierte Diagramme' Funktion und die schreibgeschützten Eigenschaften, die in der Android Version dokumentiert sind. Überprüfe den vorhandenen Quellcode, um die aktuelle API zu verstehen und undokumentierte öffentliche Schnittstellen zu identifizieren. Sieh dir offene Pull Requests oder Issues an, die möglicherweise die Dokumentationsstruktur diskutiert haben. Erwäge, zuerst ein Dokumentationsgerüst zu erstellen und dann die Abschnitte für kombinierte Diagramme und schreibgeschützte Eigenschaften auszufüllen. Das offizielle Charts Repository auf GitHub (ChartsOrg/Charts) hat noch kein Dokumentationsverzeichnis, daher musst du eine Struktur vorschlagen (z. B. mit Jazzy oder Markdown).
Tech Stack
swiftios
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
4
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Über 1 Woche
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
SwiftiOS developmentCharts library knowledge
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
25