The documentation for the bundled gem has not been updated

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

メンテナーはふだん 1 日以内に返信

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

評価

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

調査の方向性

rake のアノテーションタスクと、それが ruby/ruby ソースツリーから RBS ドキュメントをどのように収集するかを確認することから始めます。リストされているバンドル済み gem がどのように表現されているかを確認し、それらを対象にするにはどのようなドキュメント方針が必要かを決定します。合意された方針と、バンドル済み gem 向けに更新されたドキュメントワークフローが整えば完了です。

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

説明

The rake annotation task generates documentation for RBS from the ruby/ruby source code. However, bundled gems are not included in the ruby/ruby source code. As a result, the rake annotate task that updates documentation does not update the documentation for bundled gems.

I think we need to decide on how to approach the documentation for bundled gems.

  • minitest
  • net-smtp
  • base64
  • bigdecimal
  • abbrev
  • nkf
  • csv
  • observer
主要言語
Ruby
スター
2.2k
フォーク
263
平均マージ
1日 20時間
マージ済み PR(30日)
64

環境構築

はじめの一歩

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

ruby/rbs のほかの issue

ruby/rbs の issue をすべて見る

似ている issue

Ruby の issue をもっと見る

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

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