Skip to content
Wim Jongman edited this page Dec 18, 2017 · 11 revisions

Contribution Guide

All people that know Java are able to contribute to the Sloeber code. Sloeber is an Eclipse Plugin and therefore we use OSGi as our module model.

Preparing

The first thing you do is to build the Sloeber SDK by forking the Sloeber/arduino-eclipse-plugin repo and building a local SDK. To be able to build the SDK you need to install git and maven.

  • Install git
  • Install maven

Forking Sloeber

Fork the arduino-eclipse-plugin from the Sloeber organization and clone it localy.

  • git clone

Building the SDK

  • cd arduino-eclipse-plugin
  • mvn verify -P <platform>,oxygen -DSDK=true

Replace <platform> for any of win32, win64, mac64, linux32 or linux64

Install locally

After building, the product is available in

arduino-eclipse-plugin/io.sloeber.product.sdk/target/products

Move this to a short named directory e.g. c:/apps/sloebersdk or /opt/sloeber-sdk and run the sloeber-sdk executable.

PLEASE NOTE THAT THE SDK DOES NOT INCLUDE SLOEBER.

Importing the GitHub repository

After launching the SDK, open the Git perspective and add the Sloeber repository you just cloned to the repositories view.

Then import the following projects.

  • io.sloeber.ui.nl1
  • io.sloeber.application
  • io.sloeber.core
  • io.sloeber.product
  • io.sloeber.ui
  • io.sloeber.feature

Running Sloeber from the Sloeber SDK

Switch to the Java perspective and find the sloeber.product file in the product project. Open the product file with the product editor and on the first tab, find the "launch the product" link and click that.

Sloeber will now start with the SDK PLUS all the bundles in the workspace. Any changes you make in the workspace will be included in this launch.

Making changes

Pick any of the issues in the Sloeber Github Issues database and make a new branch out of it. Fix and test your code locally, push it to your remote and do a pull request.