← Back to branch summary

~dkuhlman/python-training-materials/Materials

« back to all changes in this revision

Viewing changes to python-3.5.2-docs-html/_sources/bugs.txt

  • Committer: Dave Kuhlman
  • Date: 2017-04-15 16:24:56 UTC
  • Revision ID: dkuhlman@davekuhlman.org-20170415162456-iav9vozzg4iwqwv3
Updated docs

Show diffs side-by-side

added added

removed removed

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