HowToJoin

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

参加資格

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

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

参加方法

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

必要なもの

• Git
  • 本格的にるりまを書くのに必要
• Subversion
  • Rubyの最新版を取得するのに必要だが、Gitで代用可能
• 開発中の Ruby 本体をビルドできる環境
• 1.8.x の最新バージョンの Ruby 本体
• 1.9.x の最新バージョンの Ruby 本体
• 2.x.y の最新バージョンの Ruby 本体
• patch level に関しては最大のものを用意するのが望ましい

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

参加した後の手続き

プロジェクトに参加したら、 各自必要な手続きを済ませてください。 以下に手続きとその必要度を示します。 Git レポジトリについては GitRepository を参照してください。

• BitClust のチェックアウト
  • Gem で BitClust を入れれば不要
• ドキュメントのチェックアウト
  • まともに活動するなら必須
• GitHub アカウント
  • まともに活動するなら必須
• Gitter のrurema/Lobby
  • チャット。Issueを立てるまでもない相談など

作業をはじめる

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

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

辞め方

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

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