Improve documentation
まだ誰も着手していません。
評価
- 難易度
- 1/5
- 見積もり時間
- 1時間未満
- 初心者へのやさしさ
- 50/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 停滞
- 技術スタック
- ruby
調査の方向性
README.md の例から始め、リンク先の Rubydoc ページにある Harvesting::Client#clients の完全なドキュメントと比較します。読者がそのドキュメントを参照するよう README を更新し、その後、リンクと周囲の案内が明確であることを確認します。
索引モデルが issue の本文から書いたものです。
説明
I realize that examples in the README.md are not the best way to document the behavior of this gem.
It would be great if we could point people to this page so that they could see complete documentation of the librtary: https://www.rubydoc.info/github/ombulabs/harvesting/Harvesting/Client#clients-instance_method
- 主要言語
- Ruby
- スター
- 29
- フォーク
- 30
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
fastruby/harvesting のほかの issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 35/100
fastruby/harvesting#69 ·
-
Line Item ModelsオープンFeature Request
難易度 3/5 1〜2日 初心者へのやさしさ 25/100
fastruby/harvesting#36 · コメント 5 件 ·
-
Feature Request
難易度 4/5 3〜5日 初心者へのやさしさ 38/100
fastruby/harvesting#12 · コメント 4 件 ·
fastruby/harvesting の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
temporalio/sdk-ruby#625 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 94/100
zerocracy/judges-action#2803 ·
メンテナーはふだん 5 日以内に返信
-
empty tone.rbオープン
難易度 1/5 1時間未満 初心者へのやさしさ 78/100
-
難易度 1/5 1〜3時間 初心者へのやさしさ 92/100