docs/BUGS

   1 How To Report A Bug
   2 ===================
   3
   4 If you think you've discovered a bug, please read through these guidelines
   5 before reporting it.
   6
   7 First, make sure it's a new bug:
   8
   9 * Please check the list of known bugs at the WiFi Radar Bug Tracker
  10   on berliOS to see if it has already been reported.
  11
  12 * Are you using the very latest version of WiFi Radar?  The bug may have
  13   already been fixed.  Please get the latest version of WiFi Radar from
  14   the web site and check again.  Even if your bug has not been fixed,
  15   others probably have, and you're better off with the most up-to-date code.
  16
  17   If you don't have time to check the latest version, please report the bug
  18   anyway.  I'd rather tell you that it's already fixed than miss reports of
  19   unfixed bugs.
  20
  21 * If WiFi Radar does not behave the way you expect, look in the documentation
  22   (don't forget the FAQ) and, especially, the mailing list archives for
  23   evidence that it should behave the way you expect.
  24
  25 If you're not sure, please ask on the WiFi Radar mailing list first.
  26
  27 If it's a new bug, the most important thing you can do is to write a simple
  28 description and a recipe that reproduces the bug.  The easier you make it to
  29 understand and track down the bug, the more likely a fix will be.
  30
  31 Now you're ready to write the bug report.  Please include:
  32
  33 * A clear description of the bug.  Describe how you expected WiFi Radar to
  34   behave, and contrast that with how it actually behaved.  While the bug may
  35   seem obvious to you, it may not be so obvious to someone else, so it's best
  36   to avoid a guessing game.
  37
  38 * A complete description of the environment in which you reproduced the bug:
  39
  40   - Your operating system & version.
  41   - The version of Python ("python -V").
  42   - The version of WiFi Radar (use the "-v" option).
  43   - Decrease the logging threshold to 0 and send the resulting wifi-radar.log
  44     file.
  45   - Any private modifications you made to WiFi Radar.
  46   - Anything else that could possibly be relevant.  Err on the side of too
  47     much information, rather than too little.
  48
  49 * A literal transcript of the *exact* command you ran, and the *exact* output.
  50
  51 * If you also want to include speculation as to the cause, and even a patch to
  52   fix the bug, that would be great!
  53
  54 The best place to send your bug report is to the WiFi Radar Bug Tracker on
  55 berliOS.  That way, it won't be misplaced or forgotten.  In fact, an open bug
  56 report on berliOS is a constant irritant that begs to be squashed.
  57
  58 --
  59
  60 This document was blatantly stolen from Docutils 0.5.  The original version
  61 was written by David Goodger <goodger@python.org> and placed in the public
  62 domain.  This version, edited by Sean Robinson, is licensed under the
  63 Creative Commons Attribution License.  Please attribute both authors if you
  64 re-use it.
  65