Doc/bugs.rst

   1 .. _reporting-bugs:
   2
   3 ************************
   4 Reporting Bugs in Python
   5 ************************
   6
   7 Python is a mature programming language which has established a reputation for
   8 stability.  In order to maintain this reputation, the developers would like to
   9 know of any deficiencies you find in Python.
  10
  11 Bug reports should be submitted via the Python Bug Tracker
  12 (http://bugs.python.org/).  The bug tracker offers a Web form which allows
  13 pertinent information to be entered and submitted to the developers.
  14
  15 The first step in filing a report is to determine whether the problem has
  16 already been reported.  The advantage in doing so, aside from saving the
  17 developers time, is that you learn what has been done to fix it; it may be that
  18 the problem has already been fixed for the next release, or additional
  19 information is needed (in which case you are welcome to provide it if you can!).
  20 To do this, search the bug database using the search box on the top of the page.
  21
  22 If the problem you're reporting is not already in the bug tracker, go back to
  23 the Python Bug Tracker.  If you don't already have a tracker account, select the
  24 "Register" link in the sidebar and undergo the registration procedure.
  25 Otherwise, if you're not logged in, enter your credentials and select "Login".
  26 It is not possible to submit a bug report anonymously.
  27
  28 Being now logged in, you can submit a bug.  Select the "Create New" link in the
  29 sidebar to open the bug reporting form.
  30
  31 The submission form has a number of fields.  For the "Title" field, enter a
  32 *very* short description of the problem; less than ten words is good.  In the
  33 "Type" field, select the type of your problem; also select the "Component" and
  34 "Versions" to which the bug relates.
  35
  36 In the "Comment" field, describe the problem in detail, including what you
  37 expected to happen and what did happen.  Be sure to include whether any
  38 extension modules were involved, and what hardware and software platform you
  39 were using (including version information as appropriate).
  40
  41 Each bug report will be assigned to a developer who will determine what needs to
  42 be done to correct the problem.  You will receive an update each time action is
  43 taken on the bug.
  44
  45
  46 .. seealso::
  47
  48    `How to Report Bugs Effectively <http://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_
  49       Article which goes into some detail about how to create a useful bug report.
  50       This describes what kind of information is useful and why it is useful.
  51
  52    `Bug Writing Guidelines <http://developer.mozilla.org/en/docs/Bug_writing_guidelines>`_
  53       Information about writing a good bug report.  Some of this is specific to the
  54       Mozilla project, but describes general good practices.
  55