CODING.txt

   1 == Coding guidelines ==
   2
   3 * Be sensible
   4 * Be tolerant
   5
   6 == Dependencies and targets ==
   7
   8 * We target Flash Player 9 at present. Please don't add FP10-specific code yet.
   9 * Potlatch 2 requires Flex; the Halcyon rendering component doesn't. Don't add Flex stuff (import mx.*) to anything in net.systemeD.halcyon.
  10 * Both Potlatch 2 and Halcyon can be deployed locally (i.e. not on openstreetmap.org), and indeed can talk to databases other than the main OSM instance. So don't be too OSM-specific
  11
  12 == Whitespace ==
  13
  14 * Use space, not tabs. You can only get away with tabs if your name is Richard Fairhurst
  15 * Set your editor to treat tabs as four spaces when viewing them, otherwise you'll go mad
  16 * Blank lines shouldn't have whitespace
  17 * No trailing whitespace
  18 * Only "fix" whitespace errors while changing that line of code for other reasons. Otherwise, it's not worth fixing.
  19
  20 == Indentation ==
  21
  22 package net.systemed.potlatch2.indentation {
  23
  24     class IndentedByFourSpaces {
  25
  26         public function IndentedByFourMoreSpaces():void {
  27             if (indentedCodeWithinFunctionHasTwoSpaceIndents) {
  28               // lots of places in the codebase have two-space indents within functions
  29               // like this. Don't mix and match like this example!
  30               beConsistent = true;
  31             } else {
  32                 useFourSpaceIndents = true;
  33             }
  34         }
  35     }
  36 }
  37
  38 == MXML ==
  39
  40 * Indentation is like the wild west in there. Consistency is king.