3
0
Mirror von https://github.com/GeyserMC/Geyser.git synchronisiert 2024-11-19 14:30:17 +01:00

Update CONTRIBUTING.md (#1787)

* 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>
Dieser Commit ist enthalten in:
YHDiamond 2021-01-27 19:20:27 -05:00 committet von GitHub
Ursprung 5a8604fe54
Commit f56663456d
Es konnte kein GPG-Schlüssel zu dieser Signatur gefunden werden
GPG-Schlüssel-ID: 4AEE18F83AFDEB23

Datei anzeigen

@ -11,17 +11,21 @@ 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: We have some general style guides that should be applied throughout the code:
```java ```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) { if (condition) {
// Do stuff. // Do stuff.
} else if (anotherCondition) { } else if (anotherCondition) {
@ -30,9 +34,12 @@ public void applyStuff() {
switch (value) { switch (value) {
case 0: case 0:
stuff();
break; break;
case 1: case 1:
break: differentStuff();
break;
}
} }
} }
``` ```