ChartsOrg/Charts

Create documentation

Open

#4386 aperta il 4 giu 2020

Vedi su GitHub
 (1 commento) (2 reazioni) (0 assegnatari)Swift (6009 fork)batch import
help wanted

Metriche repository

Star
 (28.002 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Concentrati sulla funzionalità 'grafici combinati' e sulle proprietà di sola lettura documentate nella versione Android. Rivedi il codice sorgente esistente per comprendere l'API attuale e identificare le interfacce pubbliche non documentate. Esamina eventuali pull request o issue aperte che potrebbero aver discusso la struttura della documentazione. Considera di creare prima uno scheletro della documentazione e poi di compilare le sezioni per i grafici combinati e le proprietà di sola lettura. Il repository ufficiale Charts su GitHub (ChartsOrg/Charts) non ha ancora una directory di documentazione, quindi dovrai proporre una struttura (ad esempio utilizzando Jazzy o Markdown).
Tech stack
swiftios
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
4
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Oltre 1 settimana
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
SwiftiOS developmentCharts library knowledge
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
25