diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 64bd54bd56..ee066f3db8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,7 +26,7 @@ This means: - `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 +- Prefer single-line javadoc `/** @return for example */` instead of multiline javadoc whenever possible - Short method/variable names (multipleLongWords should be avoided if it's possible to do so reasonably, especially for variables) - Use wildcard imports - `import some.package.*` - for everything. This makes incorrect class usage more obvious (*e.g. arc.util.Timer vs java.util.Timer*) and leads to cleaner-looking code.