tsdjs/tsd

Improve documentation

オープン

#55 opened on 2019/11/13

GitHub で見る
 (12 件のコメント) (0 件のリアクション) (0 人の担当者)TypeScript (68 件のフォーク)user submission
help wantedquestion

Repository metrics

Stars
 (2,551 個のスター)
PR merge metrics
 (30d に merged 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
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
おおむね明確
前提条件
なし
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85