ChartsOrg/Charts

Create documentation

Open

#4.386 aberto em 4 de jun. de 2020

Ver no GitHub
 (1 comment) (2 reactions) (0 assignees)Swift (6.009 forks)batch import
help wanted

Métricas do repositório

Stars
 (28.002 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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.

Guia do colaborador

Direção de pesquisa
Foque no recurso de 'gráficos combinados' e nas propriedades somente leitura que estão documentadas na versão Android. Revise o código fonte existente para entender a API atual e identificar interfaces públicas não documentadas. Veja quaisquer pull requests ou issues abertas que possam ter discutido a estrutura da documentação. Considere criar um esqueleto da documentação primeiro e depois preencher as seções para gráficos combinados e propriedades somente leitura. O repositório oficial Charts no GitHub (ChartsOrg/Charts) ainda não tem um diretório de documentação, então você precisará propor uma estrutura (por exemplo, usando Jazzy ou Markdown).
Pilha de tecnologia
swiftios
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
4
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Mais de 1 semana
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
SwiftiOS developmentCharts library knowledge
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
25