docs/DEVELOPER_GUIDELINES

   1 #
   2 #   WiFi Radar
   3 #
   4 #   DEVELOPER_GUIDELINES 2009-03-19
   5 #
   6
   7 o   Try to mimick the style of the code that you are working in.
   8
   9 o   Include a usage statement with every function/subroutine, no matter how
  10     simple and self-explanatory that function is.  Example:
  11
  12                 # Combine essid and bssid to make a config file section name
  13                 #
  14                 #Parameters:
  15                 #
  16                 #       'essid' -- string - AP ESSID
  17                 #
  18                 #       'bssid' -- string - AP BSSID
  19                 #
  20                 #Returns:
  21                 #
  22                 #       string -- the bssid concatenated to a colon, concatenated to the essid
  23                 def make_section_name( essid, bssid ):
  24                         return essid + ':' + bssid
  25
  26 o   Always give people credit in the CREDITS file.
  27
  28 o   Have fun!
  29
  30
  31 --------------------------------------------------------------------------------
  32 GIT
  33 --------------------------------------------------------------------------------
  34 o   The current development branch is "master".  It is intended for
  35     feature additions and funky stuff.  Unless you're just fixing a bug, or
  36     updating the stable documentation, this is what you want.
  37
  38
  39 --------------------------------------------------------------------------------
  40 Versioning
  41 --------------------------------------------------------------------------------
  42 o   wifi-radar uses custom versioning (X.Y.[abf]Z):
  43
  44     X = major architectural change
  45     Y = feature release
  46         o   no special meaning is given to an odd or even number
  47 [abf] = alpha, beta, or final
  48     Z = sub-revision
  49         o   aZ : no stability guarantees between releases
  50         o   bZ : new features are possible, but less wild than alpha
  51         o   fZ : bug fixes only
  52
  53 o   Development releases may be made available unofficially.
  54