Skip to content
This repository has been archived by the owner on Jan 14, 2018. It is now read-only.

Contribute to RoboSpice

stephanenicolas edited this page Jun 11, 2014 · 3 revisions

We welcome new contributions to RoboSpice. Here a re some information you may need to contribute to RoboSpice :

How to get the source code ?

RoboSpice uses submodules (for samples for instance), so you need to checkout the code using :

git clone --recursive https://github.com/octo-online/robospice

How to build RoboSpice ?

  • Install Android SDK and set the ANDROID_HOME environment variable to the Android SDK path.
  • mvn clean installfor building the library and running all tests (you need also an emulator/phisical device)
  • mvn clean install -DskipTests=truefor building without running tests.

How to contribute to RoboSpice ?

Follow the usual workflow of GitHub : fork and pull requests, comment your code, add tests.

We appreciate that all PR pass all checks and tests, even add tests if possible. Please also squash all your commits into a single one in order to ease merging and code review.

What can I do to contribute ?

It's always better to discuss your ideas before implementing them. Use our Google Group for this.

Here are some non-exhaustive suggestions :

  • provide new samples for RoboSpice. We are pretty open to adding samples that demonstrate a special combination of features (for instance using xml with the Spring Android module).
  • add new techs : We currently support a few extensions for RoboSpice and we are open to add others like Jersey client, cloud endpoints, etc..
  • make the code better : adding tests, refactoring, commenting, etc.
  • propose new ideas !