How to contribute to Eclipse Code Recommenders
Eclipse Code Recommenders makes you more productive when working with unfamiliar APIs. Its intelligent code completion and automatically-generated API documentation tell you exactly how others have solved your problem in a similar situation before.
Find Out More
If you are unfamiliar with Eclipse Code Recommenders, we suggest that you visit the project’s website first.
Sign the Contributor License Agreement
Want to contribute to Eclipse Code Recommenders? Great! But before your contribution can be accepted by the project, you need to create and electronically sign the Eclipse Foundation Contributor License Agreement (CLA).
Not sure whether there is a CLA for you on file already? You can easily check this yourself using the Contributor License Agreement Lookup Tool.
Search For and Fix Bugs
The Eclipse Code Recommenders project uses Bugzilla to track ongoing development and issues.
Be sure to search for existing issue before you create another one. Remember that contributions are always welcome!
Build Code Recommenders from Source
Building Code Recommenders from source is straight-forward. But if some of the steps below fail – let us know.
Building on the Command Line
$ git clone http://git.eclipse.org/gitroot/recommenders/org.eclipse.recommenders.git
Windows users: Code Recommenders uses Unix-style newlines (LF) throughout and fails the build if it finds Windows-style newlines (CRLF).
Please make sure that your Git configuration has
core.autocrlf set to
false to prevent Git from changing newlines to Windows-style.
(Changing newlines is unnecessary, as the Eclipse IDE can handle either style.)
After you have successfully cloned the repository, use Maven to build Eclipse Code Recommenders from scratch:
$ cd org.eclipse.recommenders $ mvn clean install
After a few minutes wait, you should see a
(The initial build may take a bit longer, as Maven automatically downloads anything required by the build.)
If you experience
OutOfMemoryErrors during the
mvn clean install step, please set the
MAVEN_OPTS environment variable as follows:
$ export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=128m"
Windows users: Substitute
set in the above command.
Building within the Eclipse IDE
If you want to contribute to Code Recommenders yourself, we suggest that you use Eclipse.
We recommend setting up Eclipse using Eclipse Oomph. Oomph will setup an up-to-date Eclipse IDE, install required and useful plugins, and import Code Recommenders’ source ready to build.
To get started with Oomph, download the installer and execute it.
Select the Eclipse product and version you wish to install, e. g.
Eclipse IDE for Java Developers.
From the list of preconfigured projects double-click
Code Recommenders/Core and click on
You will need to supply Oomph with some information to setup an Eclipse installation for you.
Some of these settings, like folder locations or names are entirely up to you.
Target Platform: at
Recommenders Git or Gerrit Repository: you can choose
SSH (read-write, Gerrit).
You need to add your SSH public key to your Eclipse Gerrit account.
Alternatively, you can choose
HTTPS (read-write, Gerrit).
In that case, you need to generate a HTTP password for authentication.
Eclipse user ID for Bugzilla/Hudson: is the e-mail address of your eclipse.org account.
Debug Port: allows you to remotely debug the installed Eclipse.
Important: No two Eclipse instances can run with the same debug port simultaneously; ensure that each instance uses its own port.
Eclipse Git/Gerrit user ID: is the username of your eclipse.org account.
When you are done, press
The installation may take several minutes. The freshly installed Eclipse will open during installation and automatically configure itself to let you work on Code Recommenders.
You are now set up to contribute code of your own to Eclipse Code Recommenders.
To test your contributions, just start an Eclipse runtime via the
tools/sdk.product product configuration file residing in the
Once you have done some changes to the code, you can submit your changes to Gerrit, where Code Recommenders committers can review your change.
To do so, right click on the
org.eclipse.recommenders project and select
For the commit comment, provide the ID of the Bugzilla issue you are working on in the format
Bug XXXXXX: Change description.
(If you are not working on an Bugzilla issue, please consider opening a new issue first.)
Also, please click the second (Add Signed-off-by) and third (Compute Change-Id for Gerrit Code Review) button above the commit message field; this will automatically generate the necessary
(Do not be alarmed if the generated ID shows as a all zeros; a proper ID will be generated once you submit the change.)
When you have composed your commit message, click on
Next, right click on the
org.eclipse.recommenders project again and select
Team/Remote/Push to Gerrit….
refs/for/master Gerrit branch, then click on
Congratulations, you have contributed your first change to Code Recommenders!
Other committers will look at your code and provide feedback. Do not be alarmed if your change is not immediately merged; most changes require a bit of back-and-forth between contributors and committers.