Permalink
Browse files

Updated CONTRIBUTING.MD to match version on wiki

  • Loading branch information...
1 parent b4a7ee9 commit b8c6b135e0da7e503e45dd985f563c11003b0766 @johnnyapol johnnyapol committed Feb 3, 2014
Showing with 10 additions and 2 deletions.
  1. +10 −2 CONTRIBUTING.md
View
@@ -10,16 +10,22 @@ If you modify a public API, or add a new one, make sure to add these changes to
If you want to poll the brains of other devs, either send a pull request and start a conversation on Github, or start a new thread in [this sub-forum](http://www.badlogicgames.com/forum/viewforum.php?f=23). You will need special forum permissions, write an e-mail to contact at badlogicgames dot com and tell me your forum id. You should also subscribe to that forum via e-mail, there's a button at the bottom of the page. You can also drop by on IRC (irc.freenode.org, #libgdx), where most core devs are lurking.
### Contributor License Agreement
+
Libgdx is licensed under the [Apache 2.0 license](http://en.wikipedia.org/wiki/Apache_License). Before we can accept code contributions, we need you to sign our [contributor license agreement](https://github.com/libgdx/libgdx/blob/master/CLA.txt). Just print it out, fill in the blanks and send a copy to contact@badlogicgames.com, with the subject `[Libgdx] CLA`.
Signing the CLA will allow us to use and distribute your code. This is a non-exclusive license, so you retain all rights to your code. It's a fail-safe for us should someone contribute essential code and later decide to take it back.
-### Eclipse Formatter
+### Eclipse Formatter
+
If you work on libgdx code, we require you to use the [Eclipse formatter](https://github.com/libgdx/libgdx/blob/master/eclipse-formatter.xml) located in the root directory of the repository.
Failure to use the formatter will result in Nate being very upset.
-### Code Style
+If you are using IntelliJ IDEA, you can still make use of the eclipse code formatter:
+see: [this article](http://blog.jetbrains.com/idea/2014/01/intellij-idea-13-importing-code-formatter-settings-from-eclipse/?utm_source=hootsuite&utm_campaign=hootsuite)
+
+### Code Style
+
Libgdx does not have an official coding standard. We mostly follow the usual [Java style](http://www.oracle.com/technetwork/java/codeconv-138413.html), and so should you.
A few things we'd rather not like to see:
@@ -39,6 +45,7 @@ If you create a new class, please add at least class documentation that explains
If your class is explicitly thread-safe, mention it in the Javadoc. The default assumption is that classes are not thread-safe, to reduce the amount of costly locks in the code base.
### Performance Considerations
+
Libgdx is meant to run on both desktop and mobile platforms, including browsers (JavaScript!). While the desktop HotSpot VM can take quite a beating in terms of unnecessary allocations, Dalvik and consorts don't.
A couple of guidelines:
@@ -52,6 +59,7 @@ A couple of guidelines:
* Use pooling if necessary, if possible, avoid exposing the pooling to the user as it complicates the API
### Git
+
Most of the libdgx team members are Git novices, as such we are just learning the ropes ourself. To lower the risk of getting something wrong, we'd kindly ask you to keep your pull requests small if possible. A change-set of 3000 files is likely not to get merged.
We do open new branches for bigger API changes. If you help out with a new API, make sure your pull request targets that specific branch.

0 comments on commit b8c6b13

Please sign in to comment.