Create CONTRIBUTING.md

This commit is contained in:
Jannik 2017-10-30 18:55:00 +01:00 committed by GitHub
parent 9c4934966c
commit b76126add1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 0 deletions

27
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,27 @@
# Contributing to cemu_UI
The following is a set of guidelines for contributing to cemu_UI.
## Java Sytleguide
If your willing to contribute to cemu_UI please us the following example as guide and rules to design your code.
* Use names for methods and variables that clarify their purpose. (This will help a lot to understand the code)
* Use as many spaces as necessary to make the code clear, but as little as possible.
* Sort all variables according to their type.
* For all (debugging) console outputs, use the log4j based logger. (syso/syse is okay for testing)
```java
// Use this as a sample Class:
public ClassName () {
void MethodName () {
double gameID; // Title-ID used on the Wii U
if (gameID == null) {
// Do something
}
// more code ...
}
}
```