Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1 | .. _reporting-bugs: |
| 2 | |
Berker Peksag | 03fe002 | 2016-06-04 21:47:44 -0700 | [diff] [blame] | 3 | ***************** |
| 4 | Dealing with 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 | |
Berker Peksag | 03fe002 | 2016-06-04 21:47:44 -0700 | [diff] [blame] | 11 | It can be sometimes faster to fix bugs yourself and contribute patches to |
| 12 | Python as it streamlines the process and involves less people. Learn how to |
| 13 | :ref:`contribute <contributing-to-python>`. |
Georg Brandl | 582c0a6 | 2010-04-22 23:20:19 +0000 | [diff] [blame] | 14 | |
| 15 | Documentation bugs |
| 16 | ================== |
| 17 | |
| 18 | If you find a bug in this documentation or would like to propose an improvement, |
Zachary Ware | 71337cb | 2014-01-14 16:03:11 -0600 | [diff] [blame] | 19 | please submit a bug report on the :ref:`tracker <using-the-tracker>`. If you |
Andre Delfino | 91c6158 | 2019-01-09 19:54:12 -0300 | [diff] [blame] | 20 | have a suggestion on how to fix it, include that as well. |
Georg Brandl | 582c0a6 | 2010-04-22 23:20:19 +0000 | [diff] [blame] | 21 | |
Zachary Ware | 3181feb | 2015-12-09 01:53:44 -0600 | [diff] [blame] | 22 | If you're short on time, you can also email documentation bug reports to |
| 23 | docs@python.org (behavioral bugs can be sent to python-list@python.org). |
Zachary Ware | 71337cb | 2014-01-14 16:03:11 -0600 | [diff] [blame] | 24 | 'docs@' is a mailing list run by volunteers; your request will be noticed, |
| 25 | though it may take a while to be processed. |
Georg Brandl | 582c0a6 | 2010-04-22 23:20:19 +0000 | [diff] [blame] | 26 | |
Zachary Ware | 71337cb | 2014-01-14 16:03:11 -0600 | [diff] [blame] | 27 | .. seealso:: |
Susan Su | 081158e | 2019-03-28 18:55:24 -0700 | [diff] [blame] | 28 | |
| 29 | `Documentation bugs`_ |
| 30 | A list of documentation bugs that have been submitted to the Python issue tracker. |
| 31 | |
| 32 | `Issue Tracking <https://devguide.python.org/tracker/>`_ |
| 33 | Overview of the process involved in reporting an improvement on the tracker. |
| 34 | |
| 35 | `Helping with Documentation <https://devguide.python.org/docquality/#helping-with-documentation>`_ |
| 36 | Comprehensive guide for individuals that are interested in contributing to Python documentation. |
Georg Brandl | 582c0a6 | 2010-04-22 23:20:19 +0000 | [diff] [blame] | 37 | |
Zachary Ware | 71337cb | 2014-01-14 16:03:11 -0600 | [diff] [blame] | 38 | .. _using-the-tracker: |
Georg Brandl | 582c0a6 | 2010-04-22 23:20:19 +0000 | [diff] [blame] | 39 | |
| 40 | Using the Python issue tracker |
| 41 | ============================== |
| 42 | |
| 43 | Bug reports for Python itself should be submitted via the Python Bug Tracker |
Alex Gaynor | 53dfcd8 | 2014-10-13 12:55:21 -0700 | [diff] [blame] | 44 | (https://bugs.python.org/). The bug tracker offers a Web form which allows |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 45 | pertinent information to be entered and submitted to the developers. |
| 46 | |
| 47 | The first step in filing a report is to determine whether the problem has |
| 48 | already been reported. The advantage in doing so, aside from saving the |
| 49 | developers time, is that you learn what has been done to fix it; it may be that |
| 50 | the problem has already been fixed for the next release, or additional |
| 51 | information is needed (in which case you are welcome to provide it if you can!). |
| 52 | To do this, search the bug database using the search box on the top of the page. |
| 53 | |
| 54 | If the problem you're reporting is not already in the bug tracker, go back to |
Georg Brandl | c0e22b7 | 2010-03-14 10:51:01 +0000 | [diff] [blame] | 55 | the Python Bug Tracker and log in. If you don't already have a tracker account, |
| 56 | select the "Register" link or, if you use OpenID, one of the OpenID provider |
| 57 | logos in the sidebar. It is not possible to submit a bug report anonymously. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 58 | |
| 59 | Being now logged in, you can submit a bug. Select the "Create New" link in the |
| 60 | sidebar to open the bug reporting form. |
| 61 | |
| 62 | The submission form has a number of fields. For the "Title" field, enter a |
| 63 | *very* short description of the problem; less than ten words is good. In the |
| 64 | "Type" field, select the type of your problem; also select the "Component" and |
| 65 | "Versions" to which the bug relates. |
| 66 | |
Christian Heimes | 81ee3ef | 2008-05-04 22:42:01 +0000 | [diff] [blame] | 67 | In the "Comment" field, describe the problem in detail, including what you |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 68 | expected to happen and what did happen. Be sure to include whether any |
| 69 | extension modules were involved, and what hardware and software platform you |
| 70 | were using (including version information as appropriate). |
| 71 | |
| 72 | Each bug report will be assigned to a developer who will determine what needs to |
| 73 | be done to correct the problem. You will receive an update each time action is |
Éric Araujo | 8ed41a8 | 2011-02-26 14:57:23 +0000 | [diff] [blame] | 74 | taken on the bug. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 75 | |
| 76 | |
| 77 | .. seealso:: |
| 78 | |
Sanyam Khurana | 1b4587a | 2017-12-06 22:09:33 +0530 | [diff] [blame] | 79 | `How to Report Bugs Effectively <https://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 80 | Article which goes into some detail about how to create a useful bug report. |
| 81 | This describes what kind of information is useful and why it is useful. |
| 82 | |
Georg Brandl | 77fe77d | 2014-10-29 09:24:54 +0100 | [diff] [blame] | 83 | `Bug Writing Guidelines <https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines>`_ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 84 | Information about writing a good bug report. Some of this is specific to the |
| 85 | Mozilla project, but describes general good practices. |
| 86 | |
Berker Peksag | 03fe002 | 2016-06-04 21:47:44 -0700 | [diff] [blame] | 87 | .. _contributing-to-python: |
Zachary Ware | 71337cb | 2014-01-14 16:03:11 -0600 | [diff] [blame] | 88 | |
| 89 | Getting started contributing to Python yourself |
| 90 | =============================================== |
| 91 | |
| 92 | Beyond just reporting bugs that you find, you are also welcome to submit |
| 93 | patches to fix them. You can find more information on how to get started |
| 94 | patching Python in the `Python Developer's Guide`_. If you have questions, |
| 95 | the `core-mentorship mailing list`_ is a friendly place to get answers to |
| 96 | any and all questions pertaining to the process of fixing issues in Python. |
| 97 | |
Georg Brandl | e73778c | 2014-10-29 08:36:35 +0100 | [diff] [blame] | 98 | .. _Documentation bugs: https://bugs.python.org/issue?@filter=status&@filter=components&components=4&status=1&@columns=id,activity,title,status&@sort=-activity |
Lisa Hewus Fresh | 384899d | 2017-08-30 09:37:43 -0700 | [diff] [blame] | 99 | .. _Python Developer's Guide: https://devguide.python.org/ |
Mariatta | e9bc417 | 2019-02-06 12:45:03 -0800 | [diff] [blame] | 100 | .. _core-mentorship mailing list: https://mail.python.org/mailman3/lists/core-mentorship.python.org/ |