diff options
author | Georg Brandl <georg@python.org> | 2007-08-15 14:28:22 (GMT) |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2007-08-15 14:28:22 (GMT) |
commit | 116aa62bf54a39697e25f21d6cf6799f7faa1349 (patch) | |
tree | 8db5729518ed4ca88e26f1e26cc8695151ca3eb3 /Doc/bugs.rst | |
parent | 739c01d47b9118d04e5722333f0e6b4d0c8bdd9e (diff) | |
download | cpython-116aa62bf54a39697e25f21d6cf6799f7faa1349.zip cpython-116aa62bf54a39697e25f21d6cf6799f7faa1349.tar.gz cpython-116aa62bf54a39697e25f21d6cf6799f7faa1349.tar.bz2 |
Move the 3k reST doc tree in place.
Diffstat (limited to 'Doc/bugs.rst')
-rw-r--r-- | Doc/bugs.rst | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/Doc/bugs.rst b/Doc/bugs.rst new file mode 100644 index 0000000..f8f75c2 --- /dev/null +++ b/Doc/bugs.rst @@ -0,0 +1,59 @@ +.. _reporting-bugs: + +************************ +Reporting Bugs in Python +************************ + +Python is a mature programming language which has established a reputation for +stability. In order to maintain this reputation, the developers would like to +know of any deficiencies you find in Python. + +If you find errors in the documentation, please use either the "Add a comment" +or the "Suggest a change" features of the relevant page in the most recent +online documentation at http://docs.python.org/. + +All other bug reports should be submitted via the Python Bug Tracker +(http://bugs.python.org/). The bug tracker offers a Web form which allows +pertinent information to be entered and submitted to the developers. + +The first step in filing a report is to determine whether the problem has +already been reported. The advantage in doing so, aside from saving the +developers time, is that you learn what has been done to fix it; it may be that +the problem has already been fixed for the next release, or additional +information is needed (in which case you are welcome to provide it if you can!). +To do this, search the bug database using the search box on the top of the page. + +If the problem you're reporting is not already in the bug tracker, go back to +the Python Bug Tracker. If you don't already have a tracker account, select the +"Register" link in the sidebar and undergo the registration procedure. +Otherwise, if you're not logged in, enter your credentials and select "Login". +It is not possible to submit a bug report anonymously. + +Being now logged in, you can submit a bug. Select the "Create New" link in the +sidebar to open the bug reporting form. + +The submission form has a number of fields. For the "Title" field, enter a +*very* short description of the problem; less than ten words is good. In the +"Type" field, select the type of your problem; also select the "Component" and +"Versions" to which the bug relates. + +In the "Change Note" field, describe the problem in detail, including what you +expected to happen and what did happen. Be sure to include whether any +extension modules were involved, and what hardware and software platform you +were using (including version information as appropriate). + +Each bug report will be assigned to a developer who will determine what needs to +be done to correct the problem. You will receive an update each time action is +taken on the bug. + + +.. seealso:: + + `How to Report Bugs Effectively <http://www-mice.cs.ucl.ac.uk/multimedia/software/documentation/ReportingBugs.html>`_ + Article which goes into some detail about how to create a useful bug report. + This describes what kind of information is useful and why it is useful. + + `Bug Writing Guidelines <http://www.mozilla.org/quality/bug-writing-guidelines.html>`_ + Information about writing a good bug report. Some of this is specific to the + Mozilla project, but describes general good practices. + |