GeyserMC/Geyser
GeyserMC/Geyser
4
4
Fork 3
mirror of https://github.com/GeyserMC/Geyser.git synced 2024-08-14 23:57:35 +00:00
Code Issues 103 Projects Releases Wiki Activity

Update CONTRIBUTING.md (#1787)

Browse source 
* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

Ok that works to but i meant for that to mean 'put all your annotation stuff here' obviously it wont compile, but this works too

Co-authored-by: theminecoder <theminecoder@users.noreply.github.com>

Co-authored-by: YHDiamond <47502993+yehudahrrs@users.noreply.github.com>
Co-authored-by: theminecoder <theminecoder@users.noreply.github.com>
This commit is contained in:
YHDiamond 2021-01-27 19:20:27 -05:00 committed by GitHub
parent 5a8604fe54
commit f56663456d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
CONTRIBUTING.md
View file

@ -11,29 +11,36 @@ Thank for for considering a contribution! Generally, Geyser welcomes PRs from ev
We have some general style guides that should be applied throughout the code:
```java
public class LongClassName {
private static final int AIR_ITEM = 0; // Static item names should be capitalized
private static final AIR_ITEM = 0; // Static item names should be capitalized
public Int2IntMap items = new Int2IntOpenHashMap(); // Use the interface as the class type but initialize with the implementation.
public Int2IntMap items = new Int2IntOpenHashMap(); // Use the interface as the class type but initialize with the implementation.
public int nameWithMultipleWords = 0;
public int nameWithMultipleWords = 0;
/**
* Javadoc comment to explain what a function does.
*/
@RandomAnnotation(stuff = true, moreStuff = "might exist")
public void applyStuff() {
Variable variable = new Variable();
Variable otherVariable = new Variable();
/**
* Javadoc comment to explain what a function does.
*/
public void applyStuff() {
if (condition) {
// Do stuff.
} else if (anotherCondition) {
// Do something else.
}
switch (value) {
case 0:
break;
case 1:
break:
}
if (condition) {
// Do stuff.
} else if (anotherCondition) {
// Do something else.
}
switch (value) {
case 0:
stuff();
break;
case 1:
differentStuff();
break;
}
}
}
```