mitm
November 2, 2017, 10:29pm
1
I have updated the
# How to contribute to jMonkeyEngine
First and foremost, you have to familiarize yourself with Git & GitHub. Dig through
[help.github.com](https://help.github.com/), [try.github.io](http://try.github.io/) and the [gh cheat sheet](https://github.com/tiimgreen/github-cheat-sheet/blob/master/README.md) if these are new topics for you. If you'd like to contribute with something other than code, just tell us about it on the forum.
## Communication
Communication always comes first. **All** code changes and other contributions should start with the [forum](http://hub.jmonkeyengine.org/). Make a thread to explain your change and show us the important bits of your code. If the code is too long to be posted within the forum’s code tags, please paste your code in a Gist or pastebin and link to the submission in your thread. You are required to register on our website in order to create threads. (We do support login via GitHub though).
### New Contributors
Check out the [Projects](https://github.com/jMonkeyEngine/jmonkeyengine/projects/1) tab, where the team has prioritized issues that you as a new contributor can undertake that will familiarize you to the workflow of contributing. This highlights some issues the team thinks would be a good start for new contributors but you are free to contribute on any other issues or integration you wish.
When you're ready to submit your code, just make a [pull request](https://help.github.com/articles/using-pull-requests).
- Do not commit your code until you have received proper feedback.
- In your commit log message, please refer back to the originating forum thread (example) for a ‘full circle’ reference. Also please [reference related issues](https://help.github.com/articles/closing-issues-via-commit-messages) by typing the issue hashtag.
- When committing, always be sure to run an update before you commit. If there is a conflict between the latest revision and your patch after the update, then it is your responsibility to track down the update that caused the conflict and determine the issue (and fix it). In the case where the breaking commit has no thread linked (and one cannot be found in the forum), then the contributor should contact an administrator and wait for feedback before committing.
- If your code is committed and it introduces new functionality, please edit the wiki accordingly. We can easily roll back to previous revisions, so just do your best; point us to it and we’ll see if it sticks!
show original
Fixing bugs and contributing code to the engines progress is a noble cause and is greatly appreciated. Doing so helps improve the engine and keeps it cutting-edge technology. However, all those changes need documenting. If your code is committed and it introduces new functionality, please edit the wiki. If this is beyond your capabilities, note the changes in a forum post with the topic ‘Documentation’, so someone can take up the cause for you.
Note that if you find that contributing to the engine is above your skill set or you just wish to participate in a different way, then becoming a Wiki Editor is highly encouraged.
See the jMonkeyEngine Documentation for how to do so.
How to edit JavaDocs - WIP
Is this ok?