From 8dc610a09100369af890c7eb044158aa3799fd3e Mon Sep 17 00:00:00 2001 From: Anuken Date: Wed, 30 Sep 2020 14:53:56 -0400 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 58eed0c4fd..f7118a2385 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,9 +24,11 @@ This means: - No spaces around parentheses: `if(condition){`, `SomeType s = (SomeType)object` - Same-line braces. - 4 spaces indentation -- `camelCase`, **even for constants or enums**. Why? Because `SCREAMING_CASE` is ugly, annoying to type and does not achieve anything useful. Constants are *less* dangerous than variables, not more. +- `camelCase`, **even for constants or enums**. Why? Because `SCREAMING_CASE` is ugly, annoying to type and does not achieve anything useful. Constants are *less* dangerous than variables, not more. Any reasonable IDE should highlight them for you anyway. - No underscores for anything. (Yes, I know `Bindings` violates this principle, but that's for legacy reasons and really should be cleaned up some day) - Do not use braceless `if/else` statements. `if(x) statement else statement2` should **never** be done. In very specific situations, having braceless if-statements on one line is allowed: `if(cond) return;` would be valid. +- Prefer single-line javadoc `/** @return for example */` instead of multiline javadoc whenver possible +- Short method/variable names (multipleLongWords should be avoided if it's possible to so reasonably, especially for variables) Import [this style file](.github/Mindustry-CodeStyle-IJ.xml) into IntelliJ to get correct formatting when developing Mindustry.