Here's how to get started with making contributions to this project:
- Install Java 8.
- Clone this repository.
- Assuming you want to use Eclipse for development, run "gradlew eclipse". This will generate Eclipse project files.
- Import your repository folder as a new project in Eclipse. Everything should compile successfully and you should be good to go.
Note that in the instructions above, "gradlew" - the Gradle wrapper - is used to process the project's build.gradle file. If you already have Gradle installed in your environment, you can just run "gradle". I believe any version of Gradle 2.x should work, but I always recommend the latest one.
To kick the tires on this library, try running any of the tests in src/test/java. The tests currently assume that your ML admin username/password is admin/admin - there's an issue for making this configurable for your local environment.
To make contributions, check out the issues in the project and follow the below, subject-to-change process:
- For a given issue, create a local branch with the name of the issue (I'll use issue #9 as an example): git checkout issue-9
- Track the local branch to a remote one: git push -u origin issue-9
- Do your work on that local feature branch, ideally making small commits. Push to remote as often as you'd like.
- When you're ready, submit a pull request from your feature branch for review.
More guidelines to come soon:
- Eclipse formatting preferences for Java
- General development guidelines