metafresh logo and link to homepage

Get the code into your IDE

Even if you just want to study the code, it probably makes a lot of sense to do so in an IDE.

Eclipse

Get and install Eclipse

Download the installer for the latest Eclipse version (currently this is Eclipse Oxygen) from http://www.eclipse.org/.
The installer will give you a choice about which “edition” to install.
“Eclipse IDE for Java Developers” will probably do. We found that at least for us, the “Eclipse IDE for Java EE Develeopers” has too much unneeded overhead.

Install Lombok

We recently started using lombok.

To enable your local Eclipse to compile the code, please go to https://projectlombok.org/download.html and follow the instructions for Eclipse. You might also want to check out our metasfresh-issue #1125 for further details.

Edit the eclipse.ini file

Open the eclipse.ini file in the Eclipse instalation directory and check the -vm value.
This is the java version Eclipse itself will run with. Please make sure that it is a recent version and a that it’s a JDK. Why that?

[...]
--launcher.appendVmargs
-vm
C:\Program Files\Java\jdk1.8.0_131\bin\javaw.exe
-vmargs
-Dosgi.requiredJavaVersion=1.8
-Dosgi.instance.area.default=@user.home/eclipse-workspace
[...]

Also, we recomment that you make sure to start eclipse with more than the default 1GB of RAM.
Look for -Xmx1024M within the eclipse.ini file and change it to e.g. -Xmx4096M (the more the better).

Import the code

Start metasfresh from within Eclipse

Note that until eclipse version neon2 the lombok integration is tricky. The recommended eclipse version is neon3, as the lombok integration works out of the box with the lombok gui installer (also across multiple eclipse projects). See here for further infos.

Optional - Install the “Eclipse Mylyn to GitHub connector”

The Eclipse Mylyn to GitHub connector is a plugin that allows you to connect mylyn to the different metasfresh repos and use mylyns features to focus on the particular issue at hand.

The connector can be installed via Eclipse’s “Help -> Install New Software…” Dialog:

developers_getting_started_ide_eclipse_install_mylyn_to_github_connector

With this connector installed, you can add GitHub-based mylyn repositories to your Eclipse instalation.

Other IDEs

We don’t yet have experince with code contributions that were created with e.g. Netbeans or IntelliJ.

We don’t think there is a need to dictate a particular IDE,

however, when contributing, please make sure to text-format your contribution in a way that allows us to get a meaningfull diff. to that end, note that your IDE might be able to import our Eclipse formatting spec.


Zur Quelldatei auf github.com