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