Contributing to JRuby

JRuby depends on community contributions to survive. Here’s how you can get involved:

Get the Source - The JRuby source is stored in our Git repository at JRuby.org and mirrored at GitHub.

  • Browse: GitHub

  • Checkout

    git clone git://jruby.org/jruby.git
    git clone http://jruby.org/repo/jruby.git
    git clone git://github.com/jruby/jruby.git
    git clone http://github.com/jruby/jruby.git

Need Git help? It’s ok, we’re not Git experts either.

Build JRuby - Once you’ve checked out the source, you just need to run "mvn" or "mvn package" to build and "mvn -Ptest" to run our Java unit test suite. We depend on Apache Maven 3.x.

  mvn
  mvn package
  mvn -Ptest

For more detailed information building and other ways to test have a look at jruby/BUILDING.md.

Check out the Hacking Guide - NaHi built an awesome Prezi fly-through tour of the JRuby codebase. Take a look through it for getting bearings with the codebase.

Report Bugs - We have 2 bug trackers. One is a JIRA hosted by the good folks at Codehaus. The other is on github. The JIRA bug tracker is in read-only mode and you should create all new issues on Github. JIRA issues only exist for historical context.

Submit Code Changes - Code changes are great. Send them back with a GitHub pull request for review.

Fix the wiki - We also depend on community contributions and edits to keep our documentation informative and relevant. If you have a useful FAQ or walkthrough or article, please add it to the wiki. And we welcome anyone who wants to help reorganize or edit existing content.

Fix the website - Our website source code is publicly available, and we graciously accept pull requests!