/Doc/bugs.rst

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