add notes on coding conventions

bpsm · Sep 16, 2012 · 596fb40 · 596fb40
1 parent 89a97db
commit 596fb40
Show file tree

Hide file tree

Showing 2 changed files with 317 additions and 0 deletions.
diff --git a/hacking/coding-conventions.md b/hacking/coding-conventions.md
@@ -0,0 +1,26 @@
+# Coding Conventions
+
+I'm coding this using Eclipse using the "Java Conventions" with 4
+spaces per indentation level.
+
+    class Foo {
+        int method() {
+            if ( ... ) {
+                ...
+            } else if ( ... ) {
+                ...
+            }
+            switch (...) {
+            case 0:
+                ...
+            default:
+                ...
+            }
+        }
+    }
+
+There should be no trailing white space. In Eclipse, configure Preferences ⇒ Java ⇒ Editor ⇒ "Save Actions" to assure this.
+
+Unit tests are useful. Have enough of those.
+
+