ChartsOrg/Charts

Create documentation

Open

#4,386 创建于 2020年6月4日

在 GitHub 查看
 (1 评论) (2 反应) (0 负责人)Swift (28,002 star) (6,009 fork)batch import
help wanted

描述

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.

贡献者指南

技术栈
swiftios
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
4
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
over 1 week
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
SwiftiOS developmentCharts library knowledge
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
25
研究方向
Focus on the 'combined charts' feature and readonly properties that are documented in the Android version. Review existing source code to understand the current API and identify undocumented public interfaces. Look at any open pull requests or issues that may have discussed documentation structure. Consider creating a documentation skeleton first and then filling in sections for combined charts and readonly properties. The official Charts repository on GitHub (ChartsOrg/Charts) has no documentation directory yet, so you'll need to propose a structure (e.g., using Jazzy or Markdown).