Ruby

= Committer How to

== How to become a committer

* Send patches to ruby-core list. Send patches, send patches and send patches.

  Someday you will be granted the commit right.

* Port Ruby to a non-POSIX platform. The core team will grant you to the permission so that you can maintain Ruby for the platform.

* Write a great library. If the core team wanted to add the library to Ruby's standard library, you will be granted the right so that you can maintain it.

  * This way is very hard because now we have RubyGems and installing a new library is easy for users.

== What to do when it is decided to give you the commit right

Send a mail with the following information to <cvs-admin AT ruby-lang.org>. [[ruby-dev:23675]], [[ruby-dev:24652]]

* Your GPG public key.

* Account name you want to use. This is for

  * Subversion

  * ((|your-account|))@ruby-lang.org

* Your SSH2 public key.

* Where to transport from ((|your-account|))@ruby-lang.org

You must sign the mail with GPG. [[ruby-dev:25599]]

=== What to need to develop Ruby

* Development environment for your platform

* Ruby - the 1.9 needs ruby for building it. (BASERUBY)

  * BASERUBY can be Ruby 1.8

* subversion

* SSH client

* GnuPG

* MUA

* IRC client

* autoconf (2.60 or later)

* bison

* (gperf)

* (git)

==== How to use GPG

How to generate your GPG keys

* ((<GnuPGの使い方|URL:http://hp.vector.co.jp/authors/VA019487/howtouse.html>))

How to sign a mail with GPG

* ((<EnigMail|URL:https://addons.mozilla.org/ja/thunderbird/addon/71>)) for Thunderbird

* ((<GPGMail|URL:http://www.sente.ch/software/GPGMail/English.lproj/GPGMail.html>)) for Apple Mail.app

==== How to generate your SSH keys

You might have your keys when you have OpenSSH. See (((%~/.ssh/id_rsa%)) or ((%~/.ssh/id_dsa%)). You can use them.

If you don't have, generate with ssh-keygen(1).

 $ ssh-keygen -b 2048 -f ruby_key

 Generating public/private rsa key pair.

 Enter passphrase (empty for no passphrase): ((|pass phrase|)) TYPE SOMETHING.

 Enter same passphrase again: ((|pass phrase|)) TYPE SOMETHING.

 Your identification has been saved in ruby_key.

 Your public key has been saved in ruby_key.pub.

 The key fingerprint is:

 XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX your@hostname

Then you will have your private key ((%ruby_key%)) and public key ((%ruby_key.pub%)). Keep your private key secret. Pass the public key to the cvs-admin.

== IRC

IRC clients

* ((<LimeChat|URL:http://limechat.net/>)) - for win, mac

* XChat (X), XChat-gnome (Gnome)

* riece (emacs)

IRC proxy bot

* ((<Nadoka|URL:http://www.atdot.net/nadoka/nadoka.en.html>))

* ((<Tiarra|URL:http://www.clovery.jp/tiarra/>))

== What to do when you become a committer

* Always build Ruby outside of (({$(srcdir)}))

  * e.g. Suppose that there are source codes in ((%/path/to/somewhere/src%)) and building at ((%/path/to/somewhere/obj%)). Then, at ((%obj%)), do ((%../src/configure%))

* Always build Ruby inside of (({$(srcdir)})) too. It is, do ((%./configure%)).

* Subscribe ruby-core and ruby-cvs.

  * subscribe ruby-dev too if you read Japanese.

* Sign up to the redmine.

  * Sign up with your mail address which you uses for sending to ruby-core.

  * Tell the mail address to another committer and ask him/her. Then (s)he will register you as a developer for [[project:Ruby].

* Keep contact to #ruby-core@freenode.

  * #ruby@ircnet:*.jp too if you read Japanese.

* Sign up to ((<Coverity|URL:http://scan.coverity.com/>)).

  * Ask how to sign up to another committer at an IRC channel.

* Get key signing to your GPG key.

  * It is preferred to get another committer's signing.

  * It is preferred to write your GPG fingerprint on your buisiness card.

== What to note when you commit

This page is under translation. See [[CommitterHowtoJa|Japanese version]] for more information.