Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
103 lines (76 loc) · 5.3 KB

CONTRIBUTING.md

File metadata and controls

103 lines (76 loc) · 5.3 KB
Raw

プロジェクトの目標

このプロジェクトの目標は、 Ruby の安定版リリースをベースとした、 完全なリファレンスマニュアルをリリースすることです。

「完全な」とは、以下のような意味を指します。

  • 言語仕様がすべて記述されている
  • すべての組み込みライブラリおよび標準添付ライブラリのドキュメントが用意されている
  • すべてのライブラリ、クラス、メソッドのドキュメントが揃っている
  • すべてのライブラリ、クラス、メソッドの実行可能なサンプルコードが揃っている
  • できることなら日本語的に優れているほうがよい
  • オンライン HTML、静的 HTML、HTML Help、EPUB3、 ReFe データベースのすべてが用意されている

ドキュメントの編集

ドキュメント本体は manual/ 配下の Markdown ファイルです （2026年7月に RD ベースの独自記法 RRD から移行しました）。

  • manual/api/ — 組み込みクラス・標準添付ライブラリ（例: manual/api/_builtin/Array.md）
  • manual/doc/ — 言語仕様などの文書
  • manual/capi/ — C API

https://docs.ruby-lang.org/ja/ の各ページ下部の編集リンクから、 該当する manual/ のファイルに直接飛べます。

旧 refm/ ツリーは凍結されています。編集しても公開サイトには反映されないため、 編集しないでください（旧バージョン向け情報の回収が終わり次第、削除予定です）。

記法は GitHub Flavored Markdown ベースです。メソッドシグネチャ （### def each {|item| ... } -> self）やクロスリファレンス（[m:Array#each]） などの独自拡張の仕様は、bitclust の MARKUP_SPEC.md を参照してください。バージョン別の記述に使う #%since / #%until などの プリプロセッサ指令は従来どおり使えます（旧 #@ prefix も後方互換で受理されます）。

ローカルでのビルド・確認:

$ bundle install
$ bundle exec rake generate:3.4    # BitClust データベース生成
$ bundle exec rake statichtml:3.4  # 静的 HTML 生成

手を動かしながらの詳しい手順は docs/Tutorial.md を、 プロジェクト文書の一覧は docs/ を参照してください。

いろいろな貢献のかたち

ドキュメントの編集以外にも、次のような貢献を歓迎しています。 資格は特に必要ありません。日本語が扱えると助かります。 Ruby でプログラミングができるとサンプルの検証などもできて便利ですが、必須ではありません。

  • ドキュメントの誤りの指摘（バージョン間違いなど） — Issue を登録してください。 最新版で修正済みかどうかを先に確認してもらえると助かります。 修正内容がわかっている場合は Pull Request にしていただけると適用が楽になります
  • ドキュメントをよりよくするための提案（説明文の追加など）
  • サンプルコードの提供
  • 既に上がっている Issue へのコメント
  • ブログや勉強会などで「るりま」を紹介する

行動規範

本プロジェクトは Ruby コミュニティの 行動規範 （Code of Conduct）に従います。

各バージョンの対応方針

以下の方針で対応します。

  • 最新安定版: 通常メンテナンス期間なので対応する
  • 1つ前の安定版: 通常メンテナンス期間なので対応する
  • 2つ前の安定版: セキュリティメンテナンス期間なので対応する
  • セキュリティメンテナンス期間が終わってEOLになったもの: そのバージョン特有のものには積極的には対応しないが、既に書いてあるものは消さない。
    • 例: 2.1がEOLになったとき、2.1.x で追加されたけど、2.2.x 以降で消えた機能については残しておく。
  • それ以前: 対応しない(outdatedな記述は消してもよい)
    • vars.rbでFROZEN_VERSIONSに移動したものはdoctreeのmasterから再生成されないので消してよい
    • 例: 2.1がEOLになったとき、2.0.x で追加されたけど、2.1.x 以降で消えた機能については消してもよい。
  • あるバージョンがEOLになったらその時点でタグを打つ
  • ただし、2026年7月のMarkdown移行から当面の間は3.0以降に対応する

具体例

例えば2026年7月時点では、

  • 最新安定版: 4.0 系列
  • 1つ前の安定版: 3.4 系列
  • 2つ前の安定版: 3.3 系列
  • セキュリティメンテナンス期間が終わってEOLになったもの: 3.2 系列
  • それ以前: 本来は 3.1 以前だが、当面は 2.7.0 以前

となります。

最新の状況については

などを参照してください。