Wiki

== How to become a committer
* Send good patches to ruby-core list. Send patches, send patches and send patches. Someday the core team will say "OK, commit it by yourself" and you will be granted 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 that 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 RubyGems made it easy for users to installing a new library.
* Citing from (()):

((|Jim Zemlin|)): Any final advice for an organization or an individual that wants to get involved in working on the Linux front?

((|Linus Torvalds|)): I get the question of “Where should I start?” fairly often and my advice is just don’t even ask that question. It’s more like if you’re not interested enough in one particular area that you already know what you want to try to do, don’t do it. Just let it go and then when you hit something where you say, “I could do this better” and you actually feel motivated enough that you go from saying that to doing that, you will have answered that question yourself.

== What to do for registering you as a committer
Get the approval of matz about getting a commit right.

After the approval, Send a mail with the following information to . [], []
* Your PGP public key.
* Account name you want to use. This is for
* Subversion
* ((|your-account|))@ruby-lang.org
* Your SSH2 public key.
* Where to forward your mail from ((|your-account|))@ruby-lang.org

== What to do after 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, using ((%./configure%)).
* Subscribe to ruby-core and ruby-cvs.
* subscribe to ruby-dev if you read Japanese.
* Sign up to the redmine.
* Sign up with your mail address that you use for sending to ruby-core.
* Tell the mail address to another committer and ask him/her to add you as a member of ruby-core group. (HowToManage).
* Keep contact to #ruby-core@freenode.
* #ruby-ja@ircnet or #ruby-ja@freenode too if you read Japanese.
* Sign up to (()).
* Ask how to sign up to another committer at an IRC channel.
* Get your GPG key signed.
* Let other committer sign your key.
* Print your GPG fingerprints on your business card.
* If you have github account, add your-svn-account@b2dd03c8-39d4-4d8f-98ff-823fe69b080e to your email addresses. Then you will see your icon in https://github.com/ruby/ruby/commits/trunk and so on.
* Add your entry to ((URL:http://github.org/yugui/rubycommitters)) and send a pull request.

== What to do when you commit
=== Consensus
* Never add a new feature or change a spec without discussion on the mailing list nor maintainer's permission.
* Especially on interpreter, VM, GC or such core of core, get matz's approval.
* Feel free to commit trivial changes, e.g. typo fix.
* Gradually learn what needs discussion and what you can commit without discussion. You will do a mistake and the maintainer will complain against it, but don't worry too much.
* Never commit without compiling ruby. Compiling miniruby is not sufficient.
(1) Do ((%make test%)) too. (better than just building)
(2) Do ((%make test-all%)) too. (better than just test)
(3) Do ((%make test-rubyspec%)) too. (better than just test-all)

=== Contact to a maintainer
* Some libraries are maintained on their own repository. On those libs the ones in the ruby's repository are just copy.
* Send a mail to the maintainer after commit.
* Send a patch to ruby-core and the maintainer instead of committing it directly if possible.

minitest

rdoc

rubygems

rake

soap (1.8)

wsdl (1.8)

=== Subversion
* Configuration for subversion
*
* Configuration for ssh
* Learn how to use ssh-agent. Don't repeat yourself.
* Read ssh_config(5).
* Branching
* /trunk is for development.
* Each branch for stable versions. (e.g. ruby_1_8, ruby_1_8_7)
* Never commit two or more changesets as one commit.
* Commit log
* Write exactly what you have written in ((%ChangeLog%)), with the addition of the original revision number in case of a backport.
(Without header, no tabs)
Example is like following:
* filename.c (rb_xxx_yyy): short description of this commit.
Fixes [bug:#XXXX] [ruby-core:XXXX].
(rb_zzz_aaa): yet another part.

* filename.h (MACRO_NAME): value changed.

Write as (({fix GH-XXXX})) to refer tickets in Github.
Do not write as (({[Github fixes #XXXX]})), it means redmine's ticket.

* filename (function): short description of this commit.
This should include your intention of this change.
[bug:#number] [mailinglist:number]
* filename2 (function2): additional description for this file/function.

Timestamps must be in JST (+09:00), in the style as above.

Two whitespaces between the timestamp and your name. Two whitespaces between your name and your mail address.