Skip to content

Committer How To

Jump to bottom Edit New page
Hiroshi SHIBATA edited this page Mar 19, 2024 · 13 revisions

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 rights.
  • 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 rights so that you can maintain it.
    • This way is very hard because RubyGems made it easy for users to instal a new library.
  • Citing from Linus Torvalds - Part II : Open Voices: The Linux Foundation Podcast:
    • 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.

How to register you as a committer

  1. An existing committer can suggest to make you a new committer by creating a Misc ticket in Redmine.
  2. You need to reply the ticket that you want to be a committer.
  3. Matz replies to the ticket with his approval.

It is recommended that the proposer gets a rough consensus of committers who are working in the area which you will work in. After you become a committer, these committers should review your commit, and the proposer must mentor you.

After the approval, Send an email with the following information to cvs-admin@ruby-lang.org.

Required

Optional

  • GitHub Account name
  • Redmine(bugs.ruby-lang.org) Account name or e-mail address.
    • We strongly recommend to sign up to the Redmine with your mail address because Redmine is our canonical discussion place
  • If you want to use ruby-lang.org domain for e-mail address like `foo@ruby-lang.org. Where to forward your mail from your-account@ruby-lang.org
  • We provide the free account of 1password for Ruby Core team. Please share your email address for this if you want to use it.
  • Subscribe to ruby-core for discussioning feature/bugfix of Ruby.
    • And ruby-cvs for reading every commits.
    • subscribe to ruby-dev if you read Japanese.

What to do after you become a committer

See Building Ruby. And committer should do the following things:

  • 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.

What to do when you commit

Consensus

  • Never add a new feature or change a spec without discussion on redmine/ruby-core mailing-list nor Maintainer's permission.
  • Especially on interpreter, VM, GC or such core of core, class or method naming 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 likely make mistakes and the maintainer might complain, 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-spec too. (better than just test-all)

Contact a maintainer

Git

  • Since April 23, 2019, we mainly use Git for Ruby's version control

    • master and future stable branches are only managed by Git.
    • ruby_2_6 and older branches are managed by SVN, but they're synced to Git.

  • Branching

    • master is for development.
    • ruby_*_* branches are for stable versions. Branch maintainers backport master commits to them.

  • Git repositories

    • Mirror (fetch and merge pull requests): https://github.com/ruby/ruby.git
      • To avoid overloading the master server, it's strongly recommended to use this for git fetch or git clone.
      • You may not directly push commits to master branch on GitHub, but you can merge pull requests and they'll be automatically synced to the master repository.
        • You need to be in ruby organization's ruby-committers team on GitHub to have access to merge pull requests. Ask @hsbt to get invited.
        • Even if you have access to, you may not create a topic branch on GitHub ruby/ruby . Use your own fork to create a pull request.
        • Both "Squash and merge" and "Rebase and merge" are allowed. Feel free to use what you prefer.
    • Master (for committer's push): https://git.ruby-lang.org/ruby.git

  • Setup: For committing, push to git@git.ruby-lang.org:ruby.git

    $ git clone https://github.com/ruby/ruby.git
Cloning into 'ruby'...
...
$ cd ruby
$ git config --global url.git@git.ruby-lang.org:ruby.git.pushinsteadof https://github.com/ruby/ruby.git
$ git config --add remote.origin.fetch '+refs/notes/commits:refs/notes/commits'
$ git fetch
..
From https://github.com/ruby/ruby
 * [new ref]         refs/notes/commits -> refs/notes/commits

  • Configuration for ssh

    • Learn how to use ssh-agent. Don't repeat yourself.
    • Read ssh_config(5).

  • Never commit two or more changesets as one commit.

  • Commit log

    • Referencing related tickets is a good idea. Redmine automatically updates the tickets with a reference to the commit. 
      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. see [Feature #XXXX]
    • Include the original revision hash in case of a backport
    • Write as fix https://github.com/ruby/ruby/pull/XXXX to refer tickets in Github. Do not write as [Github fixes #XXXX], it confuses with redmine's ticket.
    • Write as [skip ci] to skip Travis CI, if the commit only changes documents and you are sure.
    • Fold by 80 columns
    • You can command the Redmine in a commit message.
    • `make change` will write change.log which you can fill in and copy to commit message.

Continuous Integration (CI)

After you commit, check that CI stays green. List of CI servers used for Ruby

Documentation

RDoc

Writing RDocs is preferred: see Documentation Guide

Reference manual

Redmine

  • You can edit any wiki page. (login required)
  • Feature request or bug report on redmine
  • Send an email to <its-admin AT ruby-lang.org> for administration request.
  • You can incorporate mails in ruby-core and ruby-dev ML by Mail to issue.

Statuses

  • Open: a new ticket
  • Assigned: some people are considered qualified (this doesn't mean they are working on the ticket; you can take over it)
  • Feedback: waiting a reaction of the reporter (or someone who can solve deadlock)
  • Third Party's Issue: the ticket is completed because the issue is not Ruby's; Ruby itself is not changed
  • Rejected: the ticket is completed because the issue is invalid or some reason; Ruby itself is not changed
  • Closed: the ticket is completed; Ruby is fixed and maybe it needs to be backported

Backport field

This is advanced field. If you want to know the detail, see How to Backport.

Misc

  • Tools for compilation
    • autoconf (2.60 or later)
    • bison
    • ruby (building ruby from source needs ruby)
  • Test cases
    • Adding test cases (bootstraptest / test)
    • Testing test cases
      • make test
      • make test-all
      • "make check" executes both test and test-all.
  • Integration with ruby/spec
    • make test-spec MSPECOPT='-j' for running specs
    • Feel free to add and modify specs under spec/ruby (see spec/README.md).
    • Specs are synchronized ~monthly by eregon
  • diff format
    • unified diff (-u)
    • -p
  • GitHub: https://github.com/ruby/ruby
  • cgit: https://git.ruby-lang.org/ruby.git
  • ML : ruby-dev, ruby-list, ruby-core, ruby-talk
  • commit mail (ruby-cvs)
  • NEWS
    • Add an entry when you add a feature or change a spec.

See also

Policies

Development

For developers

For committers

Technical Information

Documentation

Miscellaneous

Clone this wiki locally