Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 1 | .. _reporting-bugs: |
| 2 | |
Georg Brandl | e11d85c | 2010-04-22 22:15:33 +0000 | [diff] [blame] | 3 | ************** |
| 4 | Reporting Bugs |
| 5 | ************** |
Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +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 | e11d85c | 2010-04-22 22:15:33 +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, |
Zachary Ware | f583f41 | 2014-01-14 16:01:32 -0600 | [diff] [blame] | 16 | please submit a bug report on the :ref:`tracker <using-the-tracker>`. If you |
| 17 | have a suggestion how to fix it, include that as well. |
Georg Brandl | e11d85c | 2010-04-22 22:15:33 +0000 | [diff] [blame] | 18 | |
Zachary Ware | f583f41 | 2014-01-14 16:01:32 -0600 | [diff] [blame] | 19 | If you're short on time, you can also email your bug report to docs@python.org. |
| 20 | 'docs@' is a mailing list run by volunteers; your request will be noticed, |
| 21 | though it may take a while to be processed. |
Georg Brandl | e11d85c | 2010-04-22 22:15:33 +0000 | [diff] [blame] | 22 | |
Zachary Ware | f583f41 | 2014-01-14 16:01:32 -0600 | [diff] [blame] | 23 | .. seealso:: |
| 24 | `Documentation bugs`_ on the Python issue tracker |
Georg Brandl | e11d85c | 2010-04-22 22:15:33 +0000 | [diff] [blame] | 25 | |
Zachary Ware | f583f41 | 2014-01-14 16:01:32 -0600 | [diff] [blame] | 26 | .. _using-the-tracker: |
Georg Brandl | e11d85c | 2010-04-22 22:15:33 +0000 | [diff] [blame] | 27 | |
| 28 | Using the Python issue tracker |
| 29 | ============================== |
| 30 | |
| 31 | Bug reports for Python itself should be submitted via the Python Bug Tracker |
Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 32 | (http://bugs.python.org/). The bug tracker offers a Web form which allows |
| 33 | pertinent information to be entered and submitted to the developers. |
| 34 | |
| 35 | The first step in filing a report is to determine whether the problem has |
| 36 | already been reported. The advantage in doing so, aside from saving the |
| 37 | developers time, is that you learn what has been done to fix it; it may be that |
| 38 | the problem has already been fixed for the next release, or additional |
| 39 | information is needed (in which case you are welcome to provide it if you can!). |
| 40 | To do this, search the bug database using the search box on the top of the page. |
| 41 | |
| 42 | If the problem you're reporting is not already in the bug tracker, go back to |
Georg Brandl | 37212ed | 2010-02-27 14:58:08 +0000 | [diff] [blame] | 43 | the Python Bug Tracker and log in. If you don't already have a tracker account, |
| 44 | select the "Register" link or, if you use OpenID, one of the OpenID provider |
| 45 | logos in the sidebar. It is not possible to submit a bug report anonymously. |
Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 46 | |
| 47 | Being now logged in, you can submit a bug. Select the "Create New" link in the |
| 48 | sidebar to open the bug reporting form. |
| 49 | |
| 50 | The submission form has a number of fields. For the "Title" field, enter a |
| 51 | *very* short description of the problem; less than ten words is good. In the |
| 52 | "Type" field, select the type of your problem; also select the "Component" and |
| 53 | "Versions" to which the bug relates. |
| 54 | |
Benjamin Peterson | 83ea2a9 | 2008-05-04 19:10:02 +0000 | [diff] [blame] | 55 | In the "Comment" field, describe the problem in detail, including what you |
Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 56 | expected to happen and what did happen. Be sure to include whether any |
| 57 | extension modules were involved, and what hardware and software platform you |
| 58 | were using (including version information as appropriate). |
| 59 | |
| 60 | Each bug report will be assigned to a developer who will determine what needs to |
| 61 | be done to correct the problem. You will receive an update each time action is |
Sandro Tosi | 117e1f0 | 2011-12-31 18:13:59 +0100 | [diff] [blame] | 62 | taken on the bug. |
Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 63 | |
| 64 | |
| 65 | .. seealso:: |
| 66 | |
Georg Brandl | fa13b5e | 2008-01-21 18:41:24 +0000 | [diff] [blame] | 67 | `How to Report Bugs Effectively <http://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_ |
Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 68 | Article which goes into some detail about how to create a useful bug report. |
| 69 | This describes what kind of information is useful and why it is useful. |
| 70 | |
Georg Brandl | 0267781 | 2008-03-15 00:20:19 +0000 | [diff] [blame] | 71 | `Bug Writing Guidelines <http://developer.mozilla.org/en/docs/Bug_writing_guidelines>`_ |
Georg Brandl | 8ec7f65 | 2007-08-15 14:28:01 +0000 | [diff] [blame] | 72 | Information about writing a good bug report. Some of this is specific to the |
| 73 | Mozilla project, but describes general good practices. |
| 74 | |
Zachary Ware | f583f41 | 2014-01-14 16:01:32 -0600 | [diff] [blame] | 75 | |
| 76 | Getting started contributing to Python yourself |
| 77 | =============================================== |
| 78 | |
| 79 | Beyond just reporting bugs that you find, you are also welcome to submit |
| 80 | patches to fix them. You can find more information on how to get started |
| 81 | patching Python in the `Python Developer's Guide`_. If you have questions, |
| 82 | the `core-mentorship mailing list`_ is a friendly place to get answers to |
| 83 | any and all questions pertaining to the process of fixing issues in Python. |
| 84 | |
| 85 | .. _Documentation bugs: http://bugs.python.org/issue?@filter=status&@filter=components&components=4&status=1&@columns=id,activity,title,status&@sort=-activity |
| 86 | .. _Python Developer's Guide: http://docs.python.org/devguide/ |
| 87 | .. _core-mentorship mailing list: https://mail.python.org/mailman/listinfo/core-mentorship/ |