1 Reporting an Issue
Ruby on Rails uses GitHub Issue Tracking to track issues (primarily bugs and contributions of new code). If you’ve found a bug in Ruby on Rails, this is the place to start. You’ll need to create a (free) GitHub account in order to either submit an issue, comment on them or create pull requests.
Bugs in the most recent released version of Ruby on Rails are likely to get the most attention. Also, the Rails core team is always interested in feedback from those who can take the time to test edge Rails (the code for the version of Rails that is currently under development). Later in this guide you’ll find out how to get edge Rails for testing.
1.1 Creating a Bug Report
If you’ve found a problem in Ruby on Rails which is not a security risk do a search in GitHub Issues in case it was already reported. If you find no issue addressing it you can add a new one. (See the next section for reporting security issues.)
At the minimum, your issue report needs a title and descriptive text. But that’s only a minimum. You should include as much relevant information as possible. You need to at least post the code sample that has the issue. Even better is to include a unit test that shows how the expected behavior is not occurring. Your goal should be to make it easy for yourself – and others – to replicate the bug and figure out a fix.
Then don’t get your hopes up. Unless you have a “Code Red, Mission Critical, The World is Coming to an End” kind of bug, you’re creating this issue report in the hope that others with the same problem will be able to collaborate with you on solving it. Do not expect that the issue report will automatically see any activity or that others will jump to fix it. Creating an issue like this is mostly to help yourself start on the path of fixing the problem and for others to confirm it with a “I’m having this problem too” comment.
1.2 Special Treatment for Security Issues
Please do not report security vulnerabilities with public GitHub issue reports. The Rails security policy page details the procedure to follow for security issues.
1.3 What About Feature Requests?
Please don’t put “feature request” items into GitHub Issues. If there’s a new feature that you want to see added to Ruby on Rails, you’ll need to write the code yourself – or convince someone else to partner with you to write the code. Later in this guide you’ll find detailed instructions for proposing a patch to Ruby on Rails. If you enter a wishlist item in GitHub Issues with no code, you can expect it to be marked “invalid” as soon as it’s reviewed.
2 Running the Test Suite
To move on from submitting bugs to helping resolve existing issues or contributing your own code to Ruby on Rails, you must be able to run its test suite. In this section of the guide you’ll learn how to set up the tests on your own computer.
2.1 Install git
Ruby on Rails uses git for source code control. The git homepage has installation instructions. There are a variety of resources on the net that will help you get familiar with git:
- Everyday Git will teach you just enough about git to get by.
- The PeepCode screencast on git ($9) is easier to follow.
- GitHub offers links to a variety of git resources.
- Pro Git is an entire book about git with a Creative Commons license.
2.2 Clone the Ruby on Rails Repository
Navigate to the folder where you want the Ruby on Rails source code (it will create its own rails subdirectory) and run:
$ git clone git://github.com/rails/rails.git $ cd rails
2.3 Set up and Run the Tests
The test suite must pass with any submitted code. No matter whether you are writing a new patch, or evaluating someone else’s, you need to be able to run the tests.
Install first libxml2 and libxslt together with their development files for Nokogiri. In Ubuntu that’s
$ sudo apt-get install libxml2 libxml2-dev libxslt1-dev
Also, SQLite3 and its development files for the sqlite3-ruby gem, in Ubuntu you’re done with
$ sudo apt-get install sqlite3 libsqlite3-dev
Get a recent version of Bundler:
$ gem install bundler
$ bundle install --without db
This command will install all dependencies except the MySQL and PostgreSQL Ruby drivers. We will come back at these soon. With dependencies installed, you can run the test suite with:
$ bundle exec rake test
You can also run tests for a specific framework, like Action Pack, by going into its directory and executing the same command:
$ cd actionpack $ bundle exec rake test
If you want to run tests from the specific directory use the TEST_DIR environment variable. For example, this will run tests inside railties/test/generators directory only:
$ cd railties $ TEST_DIR=generators bundle exec rake test
The test suite runs with warnings enabled. Ideally Ruby on Rails should issue no warning, but there may be a few, and also some from third-party libraries. Please ignore (or fix!) them if any, and submit patches that do not issue new warnings.
As of this writing they are specially noisy with Ruby 1.9. If you are sure about what you are doing and would like to have a more clear output, there’s a way to override the flag:
$ RUBYOPT=-W0 bundle exec rake test
2.5 Testing Active Record
The test suite of Active Record attempts to run four times, once for SQLite3, once for each of the two MySQL gems (mysql and mysql2), and once for PostgreSQL. We are going to see now how to setup the environment for them.
If you’re working with Active Record code, you must ensure that the tests pass for at least MySQL, PostgreSQL, and SQLite3. Subtle differences between the various adapters have been behind the rejection of many patches that looked OK when tested only against MySQL.
2.5.1 Set up Database Configuration
The Active Record test suite requires a custom config file: activerecord/test/config.yml. An example is provided in activerecord/test/config.example.yml which can be copied and used as needed for your environment.
The gem sqlite3-ruby does not belong to the “db” group indeed, if you followed the instructions above you’re ready. This is how you run the Active Record test suite only for SQLite3:
$ cd activerecord $ bundle exec rake test_sqlite3
2.5.3 MySQL and PostgreSQL
To be able to run the suite for MySQL and PostgreSQL we need their gems. Install first the servers, their client libraries, and their development files. In Ubuntu just run
$ sudo apt-get install mysql-server libmysqlclient15-dev $ sudo apt-get install postgresql postgresql-client postgresql-contrib libpq-dev
After that run:
$ rm .bundle/config $ bundle install
We need first to delete .bundle/config because Bundler remembers in that file that we didn’t want to install the “db” group (alternatively you can edit the file).
In order to be able to run the test suite against MySQL you need to create a user named rails with privileges on the test databases:
mysql> GRANT ALL PRIVILEGES ON activerecord_unittest.* to 'rails'@'localhost'; mysql> GRANT ALL PRIVILEGES ON activerecord_unittest2.* to 'rails'@'localhost';
and create the test databases:
$ cd activerecord $ rake mysql:build_databases
PostgreSQL’s authentication works differently. A simple way to setup the development environment for example is to run with your development account
$ sudo -u postgres createuser --superuser $USER
and after that create the test databases with
$ cd activerecord $ rake postgresql:build_databases
Using the rake task to create the test databases ensures they have the correct character set and collation.
If you’re using another database, check the files under activerecord/test/connections for default connection information. You can edit these files if you must on your machine to provide different credentials, but obviously you should not push any such changes back to Rails.
You can now run tests as you did for sqlite3, the tasks are
test_mysql test_mysql2 test_postgresql
respectively. As we mentioned before
$ bundle exec rake test
will now run the four of them in turn.
You can also invoke test_jdbcmysql, test_jdbcsqlite3 or test_jdbcpostgresql. Check out the file activerecord/RUNNING_UNIT_TESTS for information on running more targeted database tests, or the file ci/travis.rb to see the test suite that the continuous integration server runs.
2.6 Older versions of Ruby on Rails
If you want to add a fix to older versions of Ruby on Rails, you’ll need to set up and switch to your own local tracking branch. Here is an example to switch to the 3-0-stable branch:
$ git branch --track 3-0-stable origin/3-0-stable $ git checkout 3-0-stable
You may want to put your git branch name in your shell prompt to make it easier to remember which version of the code you’re working with.
3 Helping to 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’ll find lots of issues already requiring attention. What can you do for these? Quite a bit, actually:
3.1 Verifying Bug Reports
For starters, it helps to just verify bug reports. Can you reproduce the reported issue on your own computer? If so, you can add a comment to the issue saying that you’re seeing the same thing.
If something is very vague, can you help squish it down into something specific? Maybe you can provide additional information to help reproduce a bug, or eliminate needless steps that aren’t required to help demonstrate the problem.
If you find a bug report without a test, it’s very useful to contribute a failing test. This is also a great way to get started exploring the source code: looking at the existing test files will teach you how to write more tests. New tests are best contributed in the form of a patch, as explained later on in the “Contributing to the Rails Code” section.
Anything you can do to make bug reports more succinct or easier to reproduce is a help to folks trying to write code to fix those bugs – whether you end up writing the code yourself or not.
3.2 Testing Patches
You can also help out by examining pull requests that have been submitted to Ruby on Rails via GitHub. To apply someone’s changes you need to first create a dedicated branch:
$ git checkout -b testing_branch
Then you can use their remote branch to update your codebase. For example, let’s say the GitHub user JohnSmith has forked and pushed to the topic branch located at https://github.com/JohnSmith/rails.
$ git remote add JohnSmith git://github.com/JohnSmith/rails.git $ git pull JohnSmith topic
After applying their branch, test it out! Here are some things to think about:
- Does the change actually work?
- Are you happy with the tests? Can you follow what they’re testing? Are there any tests missing?
- Does it have proper documentation coverage? Should documentation elsewhere be updated?
- Do you like the implementation? Can you think of a nicer or faster way to implement a part of their change?
Once you’re happy that the pull request contains a good change, comment on the GitHub issue indicating your approval. Your comment should indicate that you like the change and what you like about it. Something like:
I like the way you’ve restructured that code in generate_finder_sql, much nicer. The tests look good too.
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 pull request.
4 Contributing to the Rails Documentation
Ruby on Rails has two main sets of documentation: The guides help you to learn Ruby on Rails, and the API is a reference.
You can help improve the Rails guides by making them more coherent, adding missing information, correcting factual errors, fixing typos, bringing it up to date with the latest edge Rails. To get involved in the translation of Rails guides, please see Translating Rails Guides.
If you’re confident about your changes, you can push them yourself directly via docrails. docrails is a branch with an open commit policy and public write access. Commits to docrails are still reviewed, but that happens after they are pushed. docrails is merged with master regularly, so you are effectively editing the Ruby on Rails documentation.
If you are unsure of the documentation changes, you can create an issue in the Rails issues tracker on GitHub.
As explained earlier, ordinary code patches should have proper documentation coverage. docrails is only used for isolated documentation improvements.
To help our CI servers you can add [ci skip] tag to your documentation commit message to skip build on that commit. Please remember to use it for commits containing only documentation changes.
docrails has a very strict policy: no code can be touched whatsoever, no matter how trivial or small the change. Only RDoc and guides can be edited via docrails. Also, CHANGELOGs should never be edited in docrails.
5 Contributing to the Rails Code
5.1 Clone the Rails Repository
The first thing you need to do to be able to contribute code is to clone the repository:
$ git clone git://github.com/rails/rails.git
and create a dedicated branch:
$ cd rails $ git checkout -b my_new_branch
It doesn’t really matter what name you use, because this branch will only exist on your local computer and your personal repository on Github. It won’t be part of the Rails git repository.
5.2 Write Your Code
Now get busy and add or edit code. You’re on your branch now, so you can write whatever you want (you can check to make sure you’re on the right branch with git branch -a). But if you’re planning to submit your change back for inclusion in Rails, keep a few things in mind:
- Get the code right
- Use Rails idioms and helpers
- Include tests that fail without your code, and pass with it
- Update the documentation, the surrounding one, examples elsewhere, guides, whatever is affected by your contribution
5.3 Follow the Coding Conventions
Rails follows a simple set of coding style conventions.
- Two spaces, no tabs (for indentation).
- No trailing whitespace. Blank lines should not have any spaces.
- Indent after private/protected.
- Prefer &&/|| over and/or.
- Prefer class << self over self.method for class methods.
- Use MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
- Use a = b and not a=b.
- Follow the conventions in the source you see used already.
The above are guidelines — please use your best judgment in using them.
5.4 Updating the CHANGELOG
The CHANGELOG is an important part of every release. It keeps the list of changes for every Rails version.
You should add an entry to the CHANGELOG of the framework that you modified if you’re adding or removing a feature, commiting a bug fix or adding deprecation notices. Refactorings and documentation changes generally should not go to the CHANGELOG.
A CHANGELOG entry should summarize what was changed and should end with author’s name. You can use multiple lines if you need more space and you can attach code examples indented with 4 spaces. If a change is related to a specific issue, you should attach issue’s number. Here is an example CHANGELOG entry:
* Summary of a change that briefly describes what was changed. You can use multiple lines and wrap them at around 80 characters. Code examples are ok, too, if needed: class Foo def bar puts 'baz' end end You can continue after the code example and you can attach issue number. GH#1234 * Your Name *
Your name can be added directly after the last word if you don’t provide any code examples or don’t need multiple paragraphs. Otherwise, it’s best to make as a new paragraph.
5.5 Sanity Check
You should not be the only person who looks at the code before you submit it. You know at least one other Rails developer, right? Show them what you’re doing and ask for feedback. Doing this in private before you push a patch out publicly is the “smoke test” for a patch: if you can’t convince one other developer of the beauty of your code, you’re unlikely to convince the core team either.
You might also want to check out the RailsBridge BugMash as a way to get involved in a group effort to improve Rails. This can help you get started and help check your code when you’re writing your first patches.
5.6 Commit Your Changes
When you’re happy with the code on your computer, you need to commit the changes to git:
$ git commit -a
At this point, your editor should be fired up and you can write a message for this commit. Well formatted and descriptive commit messages are extremely helpful for the others, especially when figuring out why given change was made, so please take the time to write it.
Good commit message should be formatted according to the following example:
Short summary (ideally 50 characters or less) More detailed description, if necessary. It should be wrapped to 72 characters. Try to be as descriptive as you can, even if you think that the commit content is obvious, it may not be obvious to others. You should add such description also if it's already present in bug tracker, it should not be necessary to visit a webpage to check the history. Description can have multiple paragraps and you can use code examples inside, just indent it with 4 spaces: class PostsController def index respond_with Post.limit(10) end end You can also add bullet points: - you can use dashes or asterisks - also, try to indent next line of a point for readability, if it's too long to fit in 72 characters
Please squash your commits into a single commit when appropriate. This simplifies future cherry picks, and also keeps the git log clean.
5.7 Update master
It’s pretty likely that other changes to master have happened while you were working. Go get them:
$ git checkout master $ git pull --rebase
Now reapply your patch on top of the latest changes:
$ git checkout my_new_branch $ git rebase master
No conflicts? Tests still pass? Change still seems reasonable to you? Then move on.
Navigate to the Rails GitHub repository and press “Fork” in the upper right hand corner.
Add the new remote to your local repository on your local machine:
$ git remote add mine email@example.com:<your user name>/rails.git
Push to your remote:
$ git push mine my_new_branch
5.9 Issue a Pull Request
Navigate to the Rails repository you just pushed to (e.g. https://github.com/your-user-name/rails) and press “Pull Request” in the upper right hand corner.
Write your branch name in branch field (is filled with master by default) and press “Update Commit Range”
Ensure the changesets you introduced are included in the “Commits” tab and that the “Files Changed” incorporate all of your changes.
Fill in some details about your potential patch including a meaningful title. When finished, press “Send pull request.” Rails Core will be notified about your submission.
5.10 Get Some Feedback
Now you need to get other people to look at your patch, just as you’ve looked at other people’s patches. You can use the rubyonrails-core mailing list or the #rails-contrib channel on IRC freenode for this. You might also try just talking to Rails developers that you know.
5.11 Iterate as Necessary
It’s entirely possible that the feedback you get will suggest changes. Don’t get discouraged: the whole point of contributing to an active open source project is to tap into community knowledge. If people are encouraging you to tweak your code, then it’s worth making the tweaks and resubmitting. If the feedback is that your code doesn’t belong in the core, you might still think about releasing it as a plugin.
And then…think about your next contribution!
6 Rails Contributors
All contributions, either via master or docrails, get credit in Rails Contributors.
You're encouraged to help improve the quality of this guide.
If you see any typos or factual errors you are confident to patch, please clone the rails repository and open a new pull request. You can also ask for commit rights on docrails if you plan to submit several patches. Commits are reviewed, but that happens after you've submitted your contribution. This repository is cross-merged with master periodically.
You may also find incomplete content, or stuff that is not up to date. Please do add any missing documentation for master. Check the Ruby on Rails Guides Guidelines for style and conventions.
If for whatever reason you spot something to fix but cannot patch it yourself, please open an issue.
And last but not least, any kind of discussion regarding Ruby on Rails documentation is very welcome in the rubyonrails-docs mailing list.