| Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1 | .. _reporting-bugs: |
| 2 | |
| Georg Brandl | 9b9e0a1 | 2010-04-22 23:20:47 +0000 | [diff] [blame] | 3 | ************** |
| 4 | Reporting Bugs |
| 5 | ************** |
| Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 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 | |
| Georg Brandl | 9b9e0a1 | 2010-04-22 23:20:47 +0000 | [diff] [blame] | 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 |
| Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 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. If you don't already have a tracker account, select the |
| 42 | "Register" link in the sidebar and undergo the registration procedure. |
| 43 | Otherwise, if you're not logged in, enter your credentials and select "Login". |
| 44 | It is not possible to submit a bug report anonymously. |
| 45 | |
| 46 | Being now logged in, you can submit a bug. Select the "Create New" link in the |
| 47 | sidebar to open the bug reporting form. |
| 48 | |
| 49 | The submission form has a number of fields. For the "Title" field, enter a |
| 50 | *very* short description of the problem; less than ten words is good. In the |
| 51 | "Type" field, select the type of your problem; also select the "Component" and |
| 52 | "Versions" to which the bug relates. |
| 53 | |
| Christian Heimes | 81ee3ef | 2008-05-04 22:42:01 +0000 | [diff] [blame] | 54 | In the "Comment" field, describe the problem in detail, including what you |
| Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 55 | expected to happen and what did happen. Be sure to include whether any |
| 56 | extension modules were involved, and what hardware and software platform you |
| 57 | were using (including version information as appropriate). |
| 58 | |
| 59 | Each bug report will be assigned to a developer who will determine what needs to |
| 60 | be done to correct the problem. You will receive an update each time action is |
| 61 | taken on the bug. |
| 62 | |
| 63 | |
| 64 | .. seealso:: |
| 65 | |
| Georg Brandl | 86def6c | 2008-01-21 20:36:10 +0000 | [diff] [blame] | 66 | `How to Report Bugs Effectively <http://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_ |
| Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 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 | |
| Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 70 | `Bug Writing Guidelines <http://developer.mozilla.org/en/docs/Bug_writing_guidelines>`_ |
| Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 71 | Information about writing a good bug report. Some of this is specific to the |
| 72 | Mozilla project, but describes general good practices. |
| 73 | |