docs/DEVELOPER_GUIDELINES

   1 #
   2 #   WiFi Radar
   3 #
   4 #   DEVELOPER_GUIDELINES 2009-03-30
   5 #
   6
   7 Try to mimick the style of the code that you are working in.
   8
   9 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 Always give people credit in the CREDITS file.
  27
  28 Have fun!
  29
  30
  31 --------------------------------------------------------------------------------
  32 GIT
  33 --------------------------------------------------------------------------------
  34 The current development branch is "v2.0.x".  It is intended for small feature
  35 additions and bug fixes.  Unless you're just fixing a bug in the stable
  36 release, or updating the stable documentation, this is what you want.
  37
  38   Primary repo: git://git.berlios.de/wifi-radar
  39   Repo mirror: git://repo.or.cz/wifi-radar.git
  40
  41
  42 --------------------------------------------------------------------------------
  43 Submitting Patches
  44 --------------------------------------------------------------------------------
  45 Please submit patches through the Patch Manager at
  46
  47     http://developer.berlios.de/patch/?group_id=10714
  48
  49 to help me keep track of incoming patches.  If you would prefer to email it,
  50 then I will try to submit it to the Patch Manager for you.
  51
  52
  53 --------------------------------------------------------------------------------
  54 Version Numbering
  55 --------------------------------------------------------------------------------
  56 WiFI Radar uses a three stage version numbering (X.Y.Z):
  57
  58     * X = major architectural change
  59     * Y = feature release
  60       no special meaning is given to an odd or even number in feature releases
  61     * Z = sub-revision: [abs]nn
  62           o [abs] = alpha, beta, or stable
  63           o nn  : 2-digit serial number
  64           o ann : no stability guarantees between releases
  65           o bnn : new features are possible, but less wild than alpha
  66           o snn : bug fixes only, no non-bug-related development will occur
  67                   in this line
  68
  69 e.g. 2.0.b01 is the first beta release for 2.0; 2.0.s05 is the fifth stable
  70 release for 2.0; 2.3.s10 is the tenth stable release for 2.3
  71
  72 Development releases (nightly repository dumps) may be made available
  73 unofficially.
  74