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