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