4 # DEVELOPER_GUIDELINES 2014-05-19
7 Try to mimick the style of the code that you are working in.
9 Include a usage docstring with every function/method, no matter how
10 simple and self-explanatory that function is. Example:
12 def make_section_name(essid, bssid):
13 """ Returns the combined 'essid' and 'bssid' to make a config file
14 section name. 'essid' and 'bssid' are strings.
16 return essid + ':' + bssid
18 Always give people credit in the CREDITS file.
23 --------------------------------------------------------------------------------
25 --------------------------------------------------------------------------------
26 The current development branch is "master". Unless you're just fixing a bug
27 in the stable release, or updating the stable documentation, this is what
30 Primary repo: git://gitorious.org/wifi-radar/wifi-radar.git
31 Repo mirror: git://repo.or.cz/wifi-radar.git
34 --------------------------------------------------------------------------------
36 --------------------------------------------------------------------------------
37 To run the available tests against WiFi Radar, use:
41 from the source root directory.
43 Currently, only unit tests, and only for some of the source code, are
47 --------------------------------------------------------------------------------
49 --------------------------------------------------------------------------------
50 Please submit patches through email or request a git pull from a public
54 --------------------------------------------------------------------------------
56 --------------------------------------------------------------------------------
57 WiFI Radar uses a three stage version numbering (X.Y.Z):
59 * X = major architectural change
61 no special meaning is given to an odd or even number in feature releases
62 * Z = sub-revision: [abs]nn
63 o [abs] = alpha, beta, or stable
64 o nn : 2-digit serial number
65 o ann : no stability guarantees between releases
66 o bnn : new features are possible, but less wild than alpha
67 o snn : bug fixes only, no non-bug-related development will occur
70 e.g. 2.0.b01 is the first beta release for 2.0; 2.0.s05 is the fifth stable
71 release for 2.0; 2.3.s10 is the tenth stable release for 2.3