257 lines
12 KiB
HTML
257 lines
12 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<title>Dealing with Bugs — Python 3.7.4 documentation</title>
|
||
<link rel="stylesheet" href="_static/pydoctheme.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||
|
||
<script type="text/javascript" src="_static/sidebar.js"></script>
|
||
|
||
<link rel="search" type="application/opensearchdescription+xml"
|
||
title="Search within Python 3.7.4 documentation"
|
||
href="_static/opensearch.xml"/>
|
||
<link rel="author" title="About these documents" href="about.html" />
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="copyright" title="Copyright" href="copyright.html" />
|
||
<link rel="next" title="Copyright" href="copyright.html" />
|
||
<link rel="prev" title="About these documents" href="about.html" />
|
||
<link rel="shortcut icon" type="image/png" href="_static/py.png" />
|
||
<link rel="canonical" href="https://docs.python.org/3/bugs.html" />
|
||
|
||
<script type="text/javascript" src="_static/copybutton.js"></script>
|
||
<script type="text/javascript" src="_static/switchers.js"></script>
|
||
|
||
|
||
|
||
<style>
|
||
@media only screen {
|
||
table.full-width-table {
|
||
width: 100%;
|
||
}
|
||
}
|
||
</style>
|
||
|
||
|
||
</head><body>
|
||
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="genindex.html" title="General Index"
|
||
accesskey="I">index</a></li>
|
||
<li class="right" >
|
||
<a href="py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="right" >
|
||
<a href="copyright.html" title="Copyright"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="about.html" title="About these documents"
|
||
accesskey="P">previous</a> |</li>
|
||
<li><img src="_static/py.png" alt=""
|
||
style="vertical-align: middle; margin-top: -1px"/></li>
|
||
<li><a href="https://www.python.org/">Python</a> »</li>
|
||
<li>
|
||
<span class="language_switcher_placeholder">en</span>
|
||
<span class="version_switcher_placeholder">3.7.4</span>
|
||
<a href="index.html">Documentation </a> »
|
||
</li>
|
||
|
||
<li class="right">
|
||
|
||
|
||
<div class="inline-search" style="display: none" role="search">
|
||
<form class="inline-search" action="search.html" method="get">
|
||
<input placeholder="Quick search" type="text" name="q" />
|
||
<input type="submit" value="Go" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
<script type="text/javascript">$('.inline-search').show(0);</script>
|
||
|
|
||
</li>
|
||
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<div class="section" id="dealing-with-bugs">
|
||
<span id="reporting-bugs"></span><h1>Dealing with Bugs<a class="headerlink" href="#dealing-with-bugs" title="Permalink to this headline">¶</a></h1>
|
||
<p>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.</p>
|
||
<p>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
|
||
<a class="reference internal" href="#contributing-to-python"><span class="std std-ref">contribute</span></a>.</p>
|
||
<div class="section" id="documentation-bugs">
|
||
<h2>Documentation bugs<a class="headerlink" href="#documentation-bugs" title="Permalink to this headline">¶</a></h2>
|
||
<p>If you find a bug in this documentation or would like to propose an improvement,
|
||
please submit a bug report on the <a class="reference internal" href="#using-the-tracker"><span class="std std-ref">tracker</span></a>. If you
|
||
have a suggestion on how to fix it, include that as well.</p>
|
||
<p>If you’re short on time, you can also email documentation bug reports to
|
||
<a class="reference external" href="mailto:docs%40python.org">docs<span>@</span>python<span>.</span>org</a> (behavioral bugs can be sent to <a class="reference external" href="mailto:python-list%40python.org">python-list<span>@</span>python<span>.</span>org</a>).
|
||
‘docs@’ is a mailing list run by volunteers; your request will be noticed,
|
||
though it may take a while to be processed.</p>
|
||
<div class="admonition seealso">
|
||
<p class="admonition-title">See also</p>
|
||
<p><a class="reference external" href="https://bugs.python.org/issue?@filter=status&@filter=components&components=4&status=1&@columns=id,activity,title,status&@sort=-activity">Documentation bugs</a> on the Python issue tracker</p>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="using-the-python-issue-tracker">
|
||
<span id="using-the-tracker"></span><h2>Using the Python issue tracker<a class="headerlink" href="#using-the-python-issue-tracker" title="Permalink to this headline">¶</a></h2>
|
||
<p>Bug reports for Python itself should be submitted via the Python Bug Tracker
|
||
(<a class="reference external" href="https://bugs.python.org/">https://bugs.python.org/</a>). The bug tracker offers a Web form which allows
|
||
pertinent information to be entered and submitted to the developers.</p>
|
||
<p>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.</p>
|
||
<p>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.</p>
|
||
<p>Being now logged in, you can submit a bug. Select the “Create New” link in the
|
||
sidebar to open the bug reporting form.</p>
|
||
<p>The submission form has a number of fields. For the “Title” field, enter a
|
||
<em>very</em> 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.</p>
|
||
<p>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).</p>
|
||
<p>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.</p>
|
||
<div class="admonition seealso">
|
||
<p class="admonition-title">See also</p>
|
||
<dl class="simple">
|
||
<dt><a class="reference external" href="https://www.chiark.greenend.org.uk/~sgtatham/bugs.html">How to Report Bugs Effectively</a></dt><dd><p>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.</p>
|
||
</dd>
|
||
<dt><a class="reference external" href="https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines">Bug Writing Guidelines</a></dt><dd><p>Information about writing a good bug report. Some of this is specific to the
|
||
Mozilla project, but describes general good practices.</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="getting-started-contributing-to-python-yourself">
|
||
<span id="contributing-to-python"></span><h2>Getting started contributing to Python yourself<a class="headerlink" href="#getting-started-contributing-to-python-yourself" title="Permalink to this headline">¶</a></h2>
|
||
<p>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 <a class="reference external" href="https://devguide.python.org/">Python Developer’s Guide</a>. If you have questions,
|
||
the <a class="reference external" href="https://mail.python.org/mailman3/lists/core-mentorship.python.org/">core-mentorship mailing list</a> is a friendly place to get answers to
|
||
any and all questions pertaining to the process of fixing issues in Python.</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<h3><a href="contents.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Dealing with Bugs</a><ul>
|
||
<li><a class="reference internal" href="#documentation-bugs">Documentation bugs</a></li>
|
||
<li><a class="reference internal" href="#using-the-python-issue-tracker">Using the Python issue tracker</a></li>
|
||
<li><a class="reference internal" href="#getting-started-contributing-to-python-yourself">Getting started contributing to Python yourself</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="about.html"
|
||
title="previous chapter">About these documents</a></p>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="copyright.html"
|
||
title="next chapter">Copyright</a></p>
|
||
<div role="note" aria-label="source link">
|
||
<h3>This Page</h3>
|
||
<ul class="this-page-menu">
|
||
<li><a href="#">Report a Bug</a></li>
|
||
<li>
|
||
<a href="https://github.com/python/cpython/blob/3.7/Doc/bugs.rst"
|
||
rel="nofollow">Show Source
|
||
</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<h3>Navigation</h3>
|
||
<ul>
|
||
<li class="right" style="margin-right: 10px">
|
||
<a href="genindex.html" title="General Index"
|
||
>index</a></li>
|
||
<li class="right" >
|
||
<a href="py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="right" >
|
||
<a href="copyright.html" title="Copyright"
|
||
>next</a> |</li>
|
||
<li class="right" >
|
||
<a href="about.html" title="About these documents"
|
||
>previous</a> |</li>
|
||
<li><img src="_static/py.png" alt=""
|
||
style="vertical-align: middle; margin-top: -1px"/></li>
|
||
<li><a href="https://www.python.org/">Python</a> »</li>
|
||
<li>
|
||
<span class="language_switcher_placeholder">en</span>
|
||
<span class="version_switcher_placeholder">3.7.4</span>
|
||
<a href="index.html">Documentation </a> »
|
||
</li>
|
||
|
||
<li class="right">
|
||
|
||
|
||
<div class="inline-search" style="display: none" role="search">
|
||
<form class="inline-search" action="search.html" method="get">
|
||
<input placeholder="Quick search" type="text" name="q" />
|
||
<input type="submit" value="Go" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
<script type="text/javascript">$('.inline-search').show(0);</script>
|
||
|
|
||
</li>
|
||
|
||
</ul>
|
||
</div>
|
||
<div class="footer">
|
||
© <a href="copyright.html">Copyright</a> 2001-2019, Python Software Foundation.
|
||
<br />
|
||
The Python Software Foundation is a non-profit corporation.
|
||
<a href="https://www.python.org/psf/donations/">Please donate.</a>
|
||
<br />
|
||
Last updated on Jul 13, 2019.
|
||
<a href="#">Found a bug</a>?
|
||
<br />
|
||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 2.0.1.
|
||
</div>
|
||
|
||
</body>
|
||
</html> |