Add example in readme
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 30/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- typescript
調査の方向性
まずリポジトリのREADMEを読み、ライブラリの公開TypeScriptエントリーポイントを確認して、現在の使用方法に関するドキュメントを把握します。READMEに具体的な使用例と補足説明を追加します。新しいユーザーがその例に従ってライブラリを正常に使用できれば、ドキュメントは完成です。
索引モデルが issue の本文から書いたものです。
説明
we should have better usage docs for this library
cc @holgerd77
- 主要言語
- TypeScript
- スター
- 31
- フォーク
- 22
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
ChainSafe/discv5 のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
-
Implement Discv5.2オープン
難易度 5/5 1週間以上 初心者へのやさしさ 15/100
-
Remove temp non-null assertion operator再び着手できるかも @wemeetagain が 1484 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンgood first issue help wanted prio-low
-
prio-low scope-security
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
ChainSafe/discv5 の issue をすべて見る
似ている issue
-
truapi-release
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
paritytech/product-sdk#529 ·
メンテナーはふだん 1 日以内に返信
-
Environments table lists page size 5 after 30対応中かも @raus7n が今日担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
litmuschaos/litmus#5743 ·
メンテナーはふだん 2 日以内に返信
-
desktop grp:admin-donors type:graphics-bug ui-admin
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
milind-soni/OpenMausBot#6730 ·
メンテナーはふだん 1 日以内に返信
-
Status: Triage Type: Bug / Error
難易度 2/5 1〜3時間 初心者へのやさしさ 69/100
mermaid-js/mermaid-v13#1059 ·
メンテナーはふだん 1 日以内に返信