Text of docs.ruby-lang.org › en › 2.3.0 › contributing_rdoc.html as Styx crawled it on Oct 6, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

contributing - Documentation for Ruby 2.3.0

Contributing to Ruby ¶ ↑ Ruby has a vast and friendly community with hundreds of people contributing to a thriving open-source ecosystem. This guide is designed to cover ways for participating in the development of CRuby. There are plenty of ways for you to help even if you're not ready to write code or documentation. You can help by reporting issues, testing patches, and trying out beta releases with your applications.

How To Report ¶ ↑ If you've encountered a bug in Ruby please report it to the redmine issue tracker available at bugs.ruby-lang.org . Do not report security vulnerabilities here, there is a separate channel for them. There are a few simple steps you should follow in order to receive feedback on your ticket. If you haven't already, sign up for an account on the bug tracker. Try the latest version. If you aren't already using the latest version, try installing a newer stable release.

See Downloading Ruby . Look to see if anyone already reported your issue, try searching on redmine for your problem. If you can't find a ticket addressing your issue, create a new one . Choose the target version, usually current. Bugs will be first fixed in the current release and then backported . Fill in the Ruby version you're using when experiencing this issue ( ruby -v ). Attach any logs or reproducible programs to provide additional information.

Reproducible scripts should be as small as possible. Briefly describe your problem. A 2-3 sentence description will help give a quick response. Pick a category, such as core for common problems, or lib for a standard library. Check the Maintainers list and assign the ticket if there is an active maintainer for the library or feature. If the ticket doesn't have any replies after 10 days, you can send a reminder. Please reply to feedback requests.

If a bug report doesn't get any feedback, it'll eventually get rejected. Reporting to downstream distributions ¶ ↑ You can report downstream issues for the following distributions via their bug tracker: debian freebsd redhat macports etc (add your distribution bug tracker here) Platform Maintainers ¶ ↑ For platform specific bugs in Ruby, you can assign your ticket to the current maintainer for a specific platform.

The current active platform maintainers are as follows: mswin32, mswin64 (Microsoft Windows) NAKAMURA Usaku (usa) mingw32 (Minimalist GNU for Windows) Nobuyoshi Nakada (nobu) IA-64 (Debian GNU/Linux) TAKANO Mitsuhiro (takano32) Symbian OS Alexander Zavorine (azov) AIX Yutaka Kanemoto (kanemoto) FreeBSD Akinori MUSHA (knu) Solaris Naohisa Goto (ngoto) RHEL, CentOS KOSAKI Motohiro kosaki Mac OS X Kenta Murata (mrkn) cygwin, bcc32, djgpp, wince, … none. (Maintainer WANTED) Reporting Security Issues ¶ ↑ Security vulnerabilities receive special treatment since they may negatively affect many users.

There is a private mailing list that all security issues should be reported to and will be handled discretely. Email the security@ruby-lang.org list and the problem will be published after fixes have been released. You can also encrypt the issue using the PGP public key for the list. Reporting Other Issues ¶ ↑ If you're having an issue with the website, or maybe the mailing list, you can contact the webmaster to help resolve the problem.

The current webmaster is: Hiroshi SHIBATA (hsbt) You can also report issues with the ruby-lang.org website on the issue tracker: issue tracker Resolve Existing Issues ¶ ↑ As a next step beyond reporting issues you can help the core team resolve existing issues. If you check the Everyone's Issues list in GitHub Issues, you will find a lot of issues already requiring attention. What can you do for these? Quite a bit, actually: When a bug report goes for a while without any feedback, it goes to the bug graveyard which is unfortunate.

If you check the issues list you will find lots of delinquent bugs that require attention. You can help by verifying the existing tickets, try to reproduce the reported issue on your own and comment if you still experience the bug. Some issues lack attention because of too much ambiguity, to help you can narrow down the problem and provide more specific details or instructions to reproduce the bug. You might also try contributing a failing test in the form of a patch, which we will cover later in this guide.

It may also help to try out patches other contributors have submitted to redmine, if gone without notice. In this case the patch command is your friend, see man patch for more information. Basically this would go something like this: cd path / to / ruby / trunk patch - p0 < path / to / patch You will then be prompted to apply the patch with the associated files. After building ruby again, you should try to run the tests and verify if the change actually worked or fixed the bug.

It's important to provide valuable feedback on the patch that can help reach the overall goal, try to answer some of these questions: What do you like about this change? What would you do differently? Are there any other edge cases not tested? Is there any documentation that would be affected by this change? If you can answer some or all of these questions, you're on the right track. If your comment simply says “+1”, then odds are that other reviewers aren't going to take it too seriously.

Show that you took the time to review the patch. How To Request Features ¶ ↑ If there's a new feature that you want to see added to Ruby, you will need to write a convincing proposal and patch to implement the feature. For new features in CRuby, use the ‘Feature’ tracker on ruby-trunk. For non-CRuby dependent features, features that would apply to alternate Ruby implementations such as JRuby and Rubinius, use the CommonRuby tracker .

When writing a proposal be sure to check for previous discussions on the topic and have a solid use case. You will need to be persuasive and convince Matz on your new feature. You should also consider the potential compatibility issues that this new feature might raise. Consider making your feature into a gem, and if there are enough people who benefit from your feature it could help persuade ruby-core. Although feature requests can seem like an alluring way to contribute to Ruby, often these discussions can lead nowhere and exhaust time and energy that could be better spent fixing bugs.

Choose your battles. A good template for a feature proposal should look something like this: Abstract Summary of your feature Background Describe current behavior and why it is problem. Related work, such as solutions in other language helps us to understand the problem. Proposal Describe your proposal in details Details If it has complicated feature, describe it Usecase How would your feature be used? Who will benefit from it?

Discussion Discuss about this proposal. A list of pros and cons will help start discussion. Limitation Limitation of your proposal Another alternative proposal If there are alternative proposals, show them. See also Links to the other related resources Slideshow ¶ ↑ At the Ruby Developer Meeting in Japan, committers discuss Feature Proposals together in Tokyo. We will judge proposals and then accept, reject, or give feedback for them.

If you have a stalled proposal, making a slide to submit is good way to get feedback. Slides should be: One-page slide Include a corresponding ticket number MUST include a figure and/or short example code SHOULD have less sentence in natural language (try to write less than 140 characters) It is RECOMMENDED to itemize: motivation/use case, proposal, pros/cons, corner case PDF or Image (Web browsers can show it) Please note: Even if the proposal is generally acceptable, it won't be accepted without writing corner cases in the ticket Slide's example: DevelopersMeeting20130727Japan Backport Requests ¶ ↑ When a new version of Ruby is released, it starts at patch level 0 (p0), and bugs will be fixed first on the trunk branch.

If it's determined

The rest of this page is on the live site.