ChartsOrg/Charts

Create documentation

Open

#4 386 ouverte le 4 juin 2020

Voir sur GitHub
 (1 commentaire) (2 réactions) (0 assignés)Swift (6 009 forks)batch import
help wanted

Métriques du dépôt

Stars
 (28 002 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Concentrez vous sur la fonctionnalité 'graphiques combinés' et les propriétés en lecture seule qui sont documentées dans la version Android. Examinez le code source existant pour comprendre l'API actuelle et identifier les interfaces publiques non documentées. Consultez les pull requests ou issues ouvertes qui pourraient avoir discuté de la structure de la documentation. Envisagez de créer d'abord un squelette de documentation, puis de remplir les sections pour les graphiques combinés et les propriétés en lecture seule. Le dépôt officiel Charts sur GitHub (ChartsOrg/Charts) n'a pas encore de répertoire de documentation, vous devrez donc proposer une structure (par exemple, en utilisant Jazzy ou Markdown).
Stack technique
swiftios
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.
4
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Plus d'une semaine
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
SwiftiOS developmentCharts library knowledge
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
25