tsdjs/tsd

Improve documentation

Open

#55 opened on 2019年11月13日

GitHub で見る
 (12 comments) (0 reactions) (0 assignees)TypeScript (2,551 stars) (68 forks)user submission
help wantedquestion

説明

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?

コントリビューターガイド

技術スタック
typescriptnodejs
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
active
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
unclear
前提条件
Basic TypeScript knowledgeUnderstanding of tsd assertions
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
40
調査方針
The issue is open ended, seeking ideas for improving documentation. Review the 12 comments for suggestions. Look at the current README and docs folder (likely in the repository root). Consider adding examples for each assertion type as mentioned in the issue body. Engage with maintainers to clarify scope and expectations.