Write down the coding standards that we've been using up to now
authorAndy Allan <gravitystorm@gmail.com>
Mon, 13 Dec 2010 11:00:20 +0000 (11:00 +0000)
committerAndy Allan <gravitystorm@gmail.com>
Mon, 13 Dec 2010 11:00:20 +0000 (11:00 +0000)
net/systemeD/halcyon/CODING.txt [new file with mode: 0644]

diff --git a/net/systemeD/halcyon/CODING.txt b/net/systemeD/halcyon/CODING.txt
new file mode 100644 (file)
index 0000000..a45919e
--- /dev/null
@@ -0,0 +1,28 @@
+== Coding guidelines ==
+
+* Be sensible
+* Be tolerant
+
+== Whitespace ==
+
+* Use space, not tabs. You can only get away with tabs if your name is Richard Fairhurst
+* Set your editor to treat tabs as two spaces when viewing them, otherwise you'll go mad
+* Blank lines shouldn't have whitespace
+* No trailing whitespace
+* Only "fix" whitespace errors while changing that line of code for other reasons. Otherwise, it's not worth fixing.
+
+== Indentation ==
+
+package net.systemed.potlatch2.indentation {
+
+    class IndentedByFourSpaces {
+
+        public function IndentedByFourMoreSpaces:void {
+            if (indentedCodeWithinFunction) {
+              justIndentByTwoSpaces = true;
+            } else {
+              shotAtDawn = true;
+            }
+        }
+    }
+}