Doc/bugs.rst

   1 .. _reporting-bugs:
   2
   3 **************
   4 Reporting Bugs
   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
  12 Documentation bugs
  13 ==================
  14
  15 If you find a bug in this documentation or would like to propose an improvement,
  16 please send an e-mail to docs@python.org describing the bug and where you found
  17 it.  If you have a suggestion how to fix it, include that as well.
  18
  19 docs@python.org is a mailing list run by volunteers; your request will be
  20 noticed, even if it takes a while to be processed.
  21
  22 Of course, if you want a more persistent record of your issue, you can use the
  23 issue tracker for documentation bugs as well.
  24
  25
  26 Using the Python issue tracker
  27 ==============================
  28
  29 Bug reports for Python itself should be submitted via the Python Bug Tracker
  30 (http://bugs.python.org/).  The bug tracker offers a Web form which allows
  31 pertinent information to be entered and submitted to the developers.
  32
  33 The first step in filing a report is to determine whether the problem has
  34 already been reported.  The advantage in doing so, aside from saving the
  35 developers time, is that you learn what has been done to fix it; it may be that
  36 the problem has already been fixed for the next release, or additional
  37 information is needed (in which case you are welcome to provide it if you can!).
  38 To do this, search the bug database using the search box on the top of the page.
  39
  40 If the problem you're reporting is not already in the bug tracker, go back to
  41 the Python Bug Tracker and log in.  If you don't already have a tracker account,
  42 select the "Register" link or, if you use OpenID, one of the OpenID provider
  43 logos in the sidebar.  It is not possible to submit a bug report anonymously.
  44
  45 Being now logged in, you can submit a bug.  Select the "Create New" link in the
  46 sidebar to open the bug reporting form.
  47
  48 The submission form has a number of fields.  For the "Title" field, enter a
  49 *very* short description of the problem; less than ten words is good.  In the
  50 "Type" field, select the type of your problem; also select the "Component" and
  51 "Versions" to which the bug relates.
  52
  53 In the "Comment" field, describe the problem in detail, including what you
  54 expected to happen and what did happen.  Be sure to include whether any
  55 extension modules were involved, and what hardware and software platform you
  56 were using (including version information as appropriate).
  57
  58 Each bug report will be assigned to a developer who will determine what needs to
  59 be done to correct the problem.  You will receive an update each time action is
  60 taken on the bug.  See http://www.python.org/dev/workflow/ for a detailed
  61 description of the issue workflow.
  62
  63
  64 .. seealso::
  65
  66    `How to Report Bugs Effectively <http://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_
  67       Article which goes into some detail about how to create a useful bug report.
  68       This describes what kind of information is useful and why it is useful.
  69
  70    `Bug Writing Guidelines <http://developer.mozilla.org/en/docs/Bug_writing_guidelines>`_
  71       Information about writing a good bug report.  Some of this is specific to the
  72       Mozilla project, but describes general good practices.
  73