CONTRIBUTING.md

プロジェクトの目標

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

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

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

各バージョンの対応方針

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

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

具体例

例えば2018年9月時点では、

• 最新安定版: 2.5 系列
• 1つ前の安定版: 2.4 系列
• 2つ前の安定版: 2.3 系列
• セキュリティメンテナンス期間が終わってEOLになったもの: 2.2 系列
• それ以前: 2.1 以前

となります。

最新の状況については

• https://bugs.ruby-lang.org/projects/ruby/wiki/ReleaseEngineering
• https://github.com/ruby/www.ruby-lang.org/blob/master/_data/branches.yml

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