123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396 |
- <!DOCTYPE html>
- <html>
- <head>
- <meta charset="utf-8" />
- <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
- <meta property="og:title" content="Dealing with Bugs" />
- <meta property="og:type" content="website" />
- <meta property="og:url" content="https://docs.python.org/3/bugs.html" />
- <meta property="og:site_name" content="Python documentation" />
- <meta property="og:description" content="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 Pyt..." />
- <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />
- <meta property="og:image:alt" content="Python documentation" />
- <meta name="description" content="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 Pyt..." />
- <meta property="og:image:width" content="200" />
- <meta property="og:image:height" content="200" />
- <meta name="theme-color" content="#3776ab" />
- <title>Dealing with Bugs — Python 3.12.0 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
-
- <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
- <link rel="stylesheet" type="text/css" href="_static/pydoctheme.css?digest=b37c26da2f7529d09fe70b41c4b2133fe4931a90" />
- <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="_static/pygments_dark.css" />
-
- <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
- <script src="_static/jquery.js"></script>
- <script src="_static/underscore.js"></script>
- <script src="_static/doctools.js"></script>
-
- <script src="_static/sidebar.js"></script>
-
- <link rel="search" type="application/opensearchdescription+xml"
- title="Search within Python 3.12.0 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="canonical" href="https://docs.python.org/3/bugs.html" />
-
-
-
-
- <style>
- @media only screen {
- table.full-width-table {
- width: 100%;
- }
- }
- </style>
- <link rel="stylesheet" href="_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">
- <link rel="shortcut icon" type="image/png" href="_static/py.svg" />
- <script type="text/javascript" src="_static/copybutton.js"></script>
- <script type="text/javascript" src="_static/menu.js"></script>
- <script type="text/javascript" src="_static/themetoggle.js"></script>
- </head>
- <body>
- <div class="mobile-nav">
- <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
- aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
- <nav class="nav-content" role="navigation">
- <label for="menuToggler" class="toggler__label">
- <span></span>
- </label>
- <span class="nav-items-wrapper">
- <a href="https://www.python.org/" class="nav-logo">
- <img src="_static/py.svg" alt="Logo"/>
- </a>
- <span class="version_switcher_placeholder"></span>
- <form role="search" class="search" action="search.html" method="get">
- <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
- <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>
- </svg>
- <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />
- <input type="submit" value="Go"/>
- </form>
- </span>
- </nav>
- <div class="menu-wrapper">
- <nav class="menu" role="navigation" aria-label="main navigation">
- <div class="language_switcher_placeholder"></div>
-
- <label class="theme-selector-label">
- Theme
- <select class="theme-selector" oninput="activateTheme(this.value)">
- <option value="auto" selected>Auto</option>
- <option value="light">Light</option>
- <option value="dark">Dark</option>
- </select>
- </label>
- <div>
- <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>
- </div>
- <div>
- <h4>Previous topic</h4>
- <p class="topless"><a href="about.html"
- title="previous chapter">About these documents</a></p>
- </div>
- <div>
- <h4>Next topic</h4>
- <p class="topless"><a href="copyright.html"
- title="next chapter">Copyright</a></p>
- </div>
- <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/main/Doc/bugs.rst"
- rel="nofollow">Show Source
- </a>
- </li>
- </ul>
- </div>
- </nav>
- </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"
- 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.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
- <li><a href="https://www.python.org/">Python</a> »</li>
- <li class="switchers">
- <div class="language_switcher_placeholder"></div>
- <div class="version_switcher_placeholder"></div>
- </li>
- <li>
-
- </li>
- <li id="cpython-language-and-version">
- <a href="index.html">3.12.0 Documentation</a> »
- </li>
- <li class="nav-item nav-item-this"><a href="">Dealing with Bugs</a></li>
- <li class="right">
-
- <div class="inline-search" role="search">
- <form class="inline-search" action="search.html" method="get">
- <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />
- <input type="submit" value="Go" />
- </form>
- </div>
- |
- </li>
- <li class="right">
- <label class="theme-selector-label">
- Theme
- <select class="theme-selector" oninput="activateTheme(this.value)">
- <option value="auto" selected>Auto</option>
- <option value="light">Light</option>
- <option value="dark">Dark</option>
- </select>
- </label> |</li>
-
- </ul>
- </div>
- <div class="document">
- <div class="documentwrapper">
- <div class="bodywrapper">
- <div class="body" role="main">
-
- <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>
- <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>You can also open a discussion item on our
- <a class="reference external" href="https://discuss.python.org/c/documentation/26">Documentation Discourse forum</a>.</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>
- <dl class="simple">
- <dt><a class="reference external" href="https://github.com/python/cpython/issues?q=is%3Aissue+is%3Aopen+label%3Adocs">Documentation bugs</a></dt><dd><p>A list of documentation bugs that have been submitted to the Python issue tracker.</p>
- </dd>
- <dt><a class="reference external" href="https://devguide.python.org/tracker/">Issue Tracking</a></dt><dd><p>Overview of the process involved in reporting an improvement on the tracker.</p>
- </dd>
- <dt><a class="reference external" href="https://devguide.python.org/docquality/#helping-with-documentation">Helping with Documentation</a></dt><dd><p>Comprehensive guide for individuals that are interested in contributing to Python documentation.</p>
- </dd>
- <dt><a class="reference external" href="https://devguide.python.org/documenting/#translating">Documentation Translations</a></dt><dd><p>A list of GitHub pages for documentation translation and their primary contacts.</p>
- </dd>
- </dl>
- </div>
- </section>
- <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>Issue reports for Python itself should be submitted via the GitHub issues
- tracker (<a class="reference external" href="https://github.com/python/cpython/issues">https://github.com/python/cpython/issues</a>).
- The GitHub issues 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 tracker using the search box at the top of the page.</p>
- <p>If the problem you’re reporting is not already in the list, log in to GitHub.
- If you don’t already have a GitHub account, create a new account using the
- “Sign up” link.
- It is not possible to submit a bug report anonymously.</p>
- <p>Being now logged in, you can submit an issue.
- Click on the “New issue” button in the top bar to report a new issue.</p>
- <p>The submission form has two fields, “Title” and “Comment”.</p>
- <p>For the “Title” field, enter a <em>very</em> short description of the problem;
- fewer than ten words is good.</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 issue report will be reviewed by a developer who will determine what needs to
- be done to correct the problem. You will receive an update each time an action is
- taken on the issue.</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://bugzilla.mozilla.org/page.cgi?id=bug-writing.html">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>
- </section>
- <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>
- </section>
- </section>
- <div class="clearer"></div>
- </div>
- </div>
- </div>
- <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
- <div class="sphinxsidebarwrapper">
- <div>
- <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>
- </div>
- <div>
- <h4>Previous topic</h4>
- <p class="topless"><a href="about.html"
- title="previous chapter">About these documents</a></p>
- </div>
- <div>
- <h4>Next topic</h4>
- <p class="topless"><a href="copyright.html"
- title="next chapter">Copyright</a></p>
- </div>
- <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/main/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.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
- <li><a href="https://www.python.org/">Python</a> »</li>
- <li class="switchers">
- <div class="language_switcher_placeholder"></div>
- <div class="version_switcher_placeholder"></div>
- </li>
- <li>
-
- </li>
- <li id="cpython-language-and-version">
- <a href="index.html">3.12.0 Documentation</a> »
- </li>
- <li class="nav-item nav-item-this"><a href="">Dealing with Bugs</a></li>
- <li class="right">
-
- <div class="inline-search" role="search">
- <form class="inline-search" action="search.html" method="get">
- <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />
- <input type="submit" value="Go" />
- </form>
- </div>
- |
- </li>
- <li class="right">
- <label class="theme-selector-label">
- Theme
- <select class="theme-selector" oninput="activateTheme(this.value)">
- <option value="auto" selected>Auto</option>
- <option value="light">Light</option>
- <option value="dark">Dark</option>
- </select>
- </label> |</li>
-
- </ul>
- </div>
- <div class="footer">
- © <a href="copyright.html">Copyright</a> 2001-2023, Python Software Foundation.
- <br />
- This page is licensed under the Python Software Foundation License Version 2.
- <br />
- Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
- <br />
- See <a href="/license.html">History and License</a> for more information.<br />
- <br />
- The Python Software Foundation is a non-profit corporation.
- <a href="https://www.python.org/psf/donations/">Please donate.</a>
- <br />
- <br />
- Last updated on Oct 02, 2023.
- <a href="/bugs.html">Found a bug</a>?
- <br />
- Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.5.0.
- </div>
- </body>
- </html>
|