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