Incorporate feedback from randomjunk and TomH
[potlatch2.git] / CODING.txt
1 == Coding guidelines ==
2
3 * Be sensible
4 * Be tolerant
5
6 == Whitespace ==
7
8 * Use space, not tabs. You can only get away with tabs if your name is Richard Fairhurst
9 * Set your editor to treat tabs as four spaces when viewing them, otherwise you'll go mad
10 * Blank lines shouldn't have whitespace
11 * No trailing whitespace
12 * Only "fix" whitespace errors while changing that line of code for other reasons. Otherwise, it's not worth fixing.
13
14 == Indentation ==
15
16 package net.systemed.potlatch2.indentation {
17
18     class IndentedByFourSpaces {
19
20         public function IndentedByFourMoreSpaces():void {
21             if (indentedCodeWithinFunctionHasTwoSpaceIndents) {
22               // lots of places in the codebase have two-space indents within functions
23               // like this. Don't mix and match like this example!
24               beConsistent = true;
25             } else {
26                 useFourSpaceIndents = true;
27             }
28         }
29     }
30 }
31
32 == MXML ==
33
34 * Indentation is like the wild west in there. Consistency is king.