jMonkeyEngine contribution : How To
Continuing the discussion from Contribution workflow using GitHub / Gradle
The aim of this topic is to gather useful informations, to ease the path to contributions.
First of all you should read this : Contributing.
- Know Java and JME ... obviously you won't be able to contribute to JME if you don't know the programming langage Java neither if you are new to JMonkeyEngine.
- JME use Git. Have a basic knowledge of subversion tool (svn,git,hg). How to be a Git master : docs, tutorials and also there
- fork jmonkeyengine, on GitHub
- checkout your fork.
- create your working branch ‘my-branch-name`.
- Switch to the branch using ‘git checkout my-branch-name`.
step by step :
- go on GitHub and click on fork
git clone http://github.com/my-acount/my-fork.git
- & 4.
git checkout -b my-branch-name
jMonkeyEngine use Gradle for automated building. It works like Maven. Gradlew is a wrapper for a specific version of Gradle.
You want :
- to build the engine :
- to build the libs :
./gradlew dist then the libs are in /dist/lib folder
- to run examples :
- to see all the available tasks :
In order to make development easier you can install a plugin for your favorite IDE to be able to open Gradle projects.
Then open jMonkeyEngine as a Gradle project, all the tasks should be available. You can also use the jME-sdk (which is based on NetBeans).
- How to import engine changes into the SDK ?
Two options :
1. build libs place them manually into the sdk
2. build the sdk with the modified engine
- How to compile it for test runs?
"./gradlew test" will runs the unit tests.
"./gradlew run" will runs the examples.
- How to make the pull request when you’re done?
First commit your changes on your branch.
Then push your branch to your fork.
Finally create a pull request from GitHub web interface.
Note : the branch "head" can be read as "from" , "base" as "to"