#
#   WiFi Radar
#
#   DEVELOPER_GUIDELINES 2009-03-30
#

Try to mimick the style of the code that you are working in.

Include a usage statement with every function/subroutine, no matter how
simple and self-explanatory that function is.  Example:

		# Combine essid and bssid to make a config file section name
		#
		#Parameters:
		#
		#	'essid' -- string - AP ESSID
		#
		#	'bssid' -- string - AP BSSID
		#
		#Returns:
		#
		#	string -- the bssid concatenated to a colon, concatenated to the essid
		def make_section_name( essid, bssid ):
			return essid + ':' + bssid

Always give people credit in the CREDITS file.

Have fun!


--------------------------------------------------------------------------------
GIT
--------------------------------------------------------------------------------
The current development branch is "v2.0.x".  It is intended for small feature
additions and bug fixes.  Unless you're just fixing a bug in the stable
release, or updating the stable documentation, this is what you want.

  Primary repo: git://git.berlios.de/wifi-radar
  Repo mirror: git://repo.or.cz/wifi-radar.git


--------------------------------------------------------------------------------
Submitting Patches
--------------------------------------------------------------------------------
Please submit patches through the Patch Manager at

    http://developer.berlios.de/patch/?group_id=10714

to help me keep track of incoming patches.  If you would prefer to email it,
then I will try to submit it to the Patch Manager for you.


--------------------------------------------------------------------------------
Version Numbering
--------------------------------------------------------------------------------
WiFI Radar uses a three stage version numbering (X.Y.Z):

    * X = major architectural change
    * Y = feature release
      no special meaning is given to an odd or even number in feature releases
    * Z = sub-revision: [abs]nn
          o [abs] = alpha, beta, or stable
          o nn  : 2-digit serial number
          o ann : no stability guarantees between releases
          o bnn : new features are possible, but less wild than alpha
          o snn : bug fixes only, no non-bug-related development will occur
                  in this line

e.g. 2.0.b01 is the first beta release for 2.0; 2.0.s05 is the fifth stable
release for 2.0; 2.3.s10 is the tenth stable release for 2.3

Development releases (nightly repository dumps) may be made available
unofficially.

