Add example in readme

オープン
#236 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
30/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
typescript
領域
documentation

調査の方向性

まずリポジトリのREADMEを読み、ライブラリの公開TypeScriptエントリーポイントを確認して、現在の使用方法に関するドキュメントを把握します。READMEに具体的な使用例と補足説明を追加します。新しいユーザーがその例に従ってライブラリを正常に使用できれば、ドキュメントは完成です。

索引モデルが issue の本文から書いたものです。

説明

good first issue help wanted prio-low scope-documentation

we should have better usage docs for this library

cc @holgerd77

主要言語
TypeScript
スター
31
フォーク
22
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ChainSafe/discv5 のほかの issue

ChainSafe/discv5 の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。