History

プロジェクトに参加するには

参加資格

参加するために必要な資格はとくにありません。 強いて言うなら、日本語が普通に使えるほうが助かります。

なお、リファレンスマニュアル刷新計画は 日本 Ruby の会の活動の一貫として実施されていますが、 日本 Ruby の会会員でなくともこの計画には参加できます。

参加方法

ruby-reference-manual メーリングリストに参加した時点で このプロジェクトに参加したとみなします。 メーリングリストへの参加方法は MailingList のページを見てください。

必要なもの

  • Subversion
  • 開発中の ruby 本体をビルドできる環境
  • 1.8.x の最新のバージョンの ruby 本体 (できれば trunk を含めた全てのバージョン)
    • patch level に関しては最大のものを用意するのが望ましい
  • 1.9.x の最新のバージョンの ruby 本体 (できれば trunk を含めた全てのバージョン)

複数のバージョンの ruby をインストールする方法は HowToInstallRubys を参照して下さい。

参加した後の手続き

プロジェクトに参加したら、 各自必要な手続きを済ませてください。 以下に手続きとその必要度を示します。 Subversion レポジトリのアカウントの取得そのほかに関しては SubversionRepository を参照して下さい。

||| 手続き                              ||| 必要度
|| ruby-reference-manual ML 参加        || 必須
|| BitClust とドキュメントのチェックアウト || ほぼ必須
|| Subversion レポジトリのアカウント発行   || まともに活動するなら必須
|| Ruby Issue Tracking System http://redmine.ruby-lang.org/ のアカウント || まともに活動するなら必須
|| ProjectTimeLine の理解               || まともに活動するなら必須
|| ruby-reference-manual-diff ML 参加   || 入っておくと便利だがどちらでも

作業をはじめる

以下のようにして作業を始めます。

  1. Phase3WorkingScheme を読んで手順を覚える。
  2. ClassReferenceManualFormat, HowToWriteMethodEntry を読んでマニュアルのフォーマットを覚える。
  3. BitClust を読んでツールの使い方を覚える。
  4. 自分が担当する箇所を ASSIGN ファイル(rubydoc/refm/api/ASSIGN)に書き込んで ASSIGN ファイルをコミットする。
  5. マニュアルを書く。
  6. コミットする。

辞め方

ボランティアベースなのですから、辞めたくなったらいつでも気軽に辞めてください。 ただし以下を守ってください。

  • 黙って辞めない
  • 未完成の場合には ASSIGN ファイルから自分の名前を消す
  • ML でその旨報告する