summaryrefslogtreecommitdiffstatsabout

How to contribute to Eclipse Code Recommenders

Logo

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)[https://projects.eclipse.org/user/cla/validate].

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

If you want to build Code Recommenders from the command line, you will need Apache Maven, version 3.x.

$ git clone http://git.eclipse.org/gitroot/recommenders/org.eclipse.recommenders.git
$ cd org.eclipse.recommenders
$ mvn clean install

That’s it. After a few minutes wait, you should see a BUILD SUCCESS. (The initial build may take a bit longer, as Maven automatically downloads anything required by the build.)

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

Building within the Eclipse IDE

If you want to contribute to Code Recommenders yourself, we suggest that you use Eclipse.

We recommend the latest Eclipse IDE for Java and DSL Developers. This package already contains all the required and most of the recommended features for building Code Recommenders.

The following features are required for building Code Recommenders:

The following features are recommended for building Code Recommenders:

After you have installed all necessary features, you can import the source into your Eclipse IDE. But first you need to clone the Git repository and once build Code Recommenders on the command line. (See above for how to do this.)

After the command-line build has been successful, import all projects into your Eclipse workspace using the Existing Maven Projects wizard. Here, select the org.eclipse.recommenders as root directory. Upon clicking Next, the wizard should prompt you with a list of Maven plugin connectors to set up. Simply click Finish to install all necessary connectors. (Depending on which connectors still need to be installed, you may have to restart Eclipse.)

Once the projects have been imported, many of them still contain errors. This is to be expected, as Eclipse cannot yet find all their required dependencies. To fix this, you need to set a target platform which points Eclipse to these dependencies. Open either the kepler.target or luna.target file residing in the kepler or luna project, respectively, with the Target Editor. Wait until Eclipse completely resolved the target definition. Only then click on Set as target platform in the upper right corner of the editor. This causes Eclipse to build all projects again. Once this re-build is done, there should be no erroneous projects.

If you followed our recommendation and installed Workspace Mechanic, you should now open the Workspace Mechanic preferences and configure your org.eclipse.recommenders/tools/mechanic directory as a Task Source. In case Workspace Mechanic finds any of your settings amiss, just let it fix them for you.

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/ide.product product configuration file residing in the org.eclipse.recommenders project.