Doc/bugs.rst - platform/external/python/cpython3 - Gitiles

 .. _reporting-bugs:

 *****************
 Dealing with Bugs
 *****************

 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.

 It can be sometimes faster to fix bugs yourself and contribute patches to
 Python as it streamlines the process and involves less people. Learn how to
 :ref:`contribute <contributing-to-python>`.

 Documentation bugs
 ==================

 If you find a bug in this documentation or would like to propose an improvement,
 please submit a bug report on the :ref:`tracker <using-the-tracker>`.  If you
 have a suggestion on how to fix it, include that as well.

 If you're short on time, you can also email documentation bug reports to
 docs@python.org (behavioral bugs can be sent to python-list@python.org).
 'docs@' is a mailing list run by volunteers; your request will be noticed,
 though it may take a while to be processed.

 .. seealso::
    `Documentation bugs`_ on the Python issue tracker

 .. _using-the-tracker:

 Using the Python issue tracker
 ==============================

 Bug reports for Python itself should be submitted via the Python Bug Tracker
 (https://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 and log in.  If you don't already have a tracker account,
 select the "Register" link or, if you use OpenID, one of the OpenID provider
 logos in the sidebar.  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 "Comment" 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 <https://www.chiark.greenend.org.uk/~sgtatham/bugs.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 <https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines>`_
       Information about writing a good bug report.  Some of this is specific to the
       Mozilla project, but describes general good practices.

 .. _contributing-to-python:

 Getting started contributing to Python yourself
 ===============================================

 Beyond just reporting bugs that you find, you are also welcome to submit
 patches to fix them.  You can find more information on how to get started
 patching Python in the `Python Developer's Guide`_.  If you have questions,
 the `core-mentorship mailing list`_ is a friendly place to get answers to
 any and all questions pertaining to the process of fixing issues in Python.

 .. _Documentation bugs: https://bugs.python.org/issue?@filter=status&@filter=components&components=4&status=1&@columns=id,activity,title,status&@sort=-activity
 .. _Python Developer's Guide: https://devguide.python.org/
 .. _core-mentorship mailing list: https://mail.python.org/mailman/listinfo/core-mentorship/
	.. _reporting-bugs:

	*****************
	Dealing with Bugs
	*****************

	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.

	It can be sometimes faster to fix bugs yourself and contribute patches to
	Python as it streamlines the process and involves less people. Learn how to
	:ref:`contribute <contributing-to-python>`.

	Documentation bugs
	==================

	If you find a bug in this documentation or would like to propose an improvement,
	please submit a bug report on the :ref:`tracker <using-the-tracker>`. If you
	have a suggestion on how to fix it, include that as well.

	If you're short on time, you can also email documentation bug reports to
	docs@python.org (behavioral bugs can be sent to python-list@python.org).
	'docs@' is a mailing list run by volunteers; your request will be noticed,
	though it may take a while to be processed.

	.. seealso::
	`Documentation bugs`_ on the Python issue tracker

	.. _using-the-tracker:

	Using the Python issue tracker
	==============================

	Bug reports for Python itself should be submitted via the Python Bug Tracker
	(https://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 and log in. If you don't already have a tracker account,
	select the "Register" link or, if you use OpenID, one of the OpenID provider
	logos in the sidebar. 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 "Comment" 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 <https://www.chiark.greenend.org.uk/~sgtatham/bugs.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 <https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines>`_
	Information about writing a good bug report. Some of this is specific to the
	Mozilla project, but describes general good practices.

	.. _contributing-to-python:

	Getting started contributing to Python yourself
	===============================================

	Beyond just reporting bugs that you find, you are also welcome to submit
	patches to fix them. You can find more information on how to get started
	patching Python in the `Python Developer's Guide`_. If you have questions,
	the `core-mentorship mailing list`_ is a friendly place to get answers to
	any and all questions pertaining to the process of fixing issues in Python.

	.. _Documentation bugs: https://bugs.python.org/issue?@filter=status&@filter=components&components=4&status=1&@columns=id,activity,title,status&@sort=-activity
	.. _Python Developer's Guide: https://devguide.python.org/
	.. _core-mentorship mailing list: https://mail.python.org/mailman/listinfo/core-mentorship/