mirror/Slimefun4
mirror/Slimefun4
1
Fork 0
mirror of https://github.com/StarWishsama/Slimefun4.git synced 2024-09-19 19:25:48 +00:00
Code Releases Activity

[CI skip] Updated contributing.md again

Browse Source
This commit is contained in:
TheBusyBiscuit 2021-06-03 18:42:31 +02:00
parent 6071e1b952
commit 6ae9f6a31e
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -168,10 +168,20 @@ public @Nullable String getString() {
}
```
* Comments should never go on the same line as code! Always above or below.
* When you deviate from this style, add formatter comments and explain why. Example:
```java
// @formatter:off - This array represents a 3x3 grid and should be shown as such.
String[] arrays = {
"1", "2", "3",
"4", "5", "6",
"7", "8", "9"
};
// @formatter:off
```
* Make sure that empty lines are truly empty, they should not contain any whitespace characters.
* Empty blocks like constructors should not occupy more than one line. (e.g. `private MyClass() {}`)
* Modifiers for classes and fields must follow this order:<br>
`(public/protected/private) (abstract) (static) (final)`
`[public/protected/private] [abstract] [static] [final]`
* We recommend using horizontal whitespaces like this:
* In variable assignments: `int x = 123;`
* In a for-loop: `for (int i = 0; i < 10; i++) {`