tsdjs/tsd

Improve documentation

Open

#55 创建于 2019年11月13日

在 GitHub 查看
 (12 评论) (0 反应) (0 负责人)TypeScript (68 fork)user submission
help wantedquestion

仓库指标

Star
 (2,551 star)
PR 合并指标
 (30 天内没有已合并 PR)

描述

I think we need to improve the documentation a bit. But I'm not sure how to provide the right amount of information.

So any ideas here are more than welcome. Like, should we add more examples? Should we add an example per assertion to make it more clear? Is the description good enough?

贡献者指南

研究方向
审查现有文档和示例，找出差距，并提出具体改进建议，例如为每个断言添加示例或澄清描述。
技术栈
typescript
领域
documentationdeveloper experience
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
基本清晰
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85