[Python-Dev] checklist for filing a bug

Brett Cannon bcannon at gmail.com
Fri Jul 8 06:19:05 CEST 2005


In order to lower the barrier for reporting bugs, writing patches, and
handling CVS commits, I am writing up checklists for each and I will
put them up on python.org.

The first checklist is for bug reports.  All comments welcome.  Keep
in mind the list is supposed to be short and straight-forward; too
wordy and people won't read it.

Reporting a Bug
+++++++++++++++
For technical question for any step listed, refer to the `dev FAQ`_.

#. Make sure the bug is reproducible
    The bug cannot be a freak occurence and must be reproducible so developers
    can test against it.
#. Isolate bug
    Come up with a code snippet that is as succinct as possible that triggers
    the bug consistently.  Coding it as a unit test is the best.
#. Gather important information
    Info such as Python version, operating system version, etc.; anything that
    might have influenced the code that lead to the bug.
#. Report the bug on SourceForge_
    Create a new tracker item, filling out the ``Category`` and ``Group``
    fields.  Do not set the ``Assigned To`` or ``Priority`` fields.  Upload  
    your code snippet as a file and make sure to click the ``Upload`` button! 


.. _dev FAQ: http://www.python.org/dev/devfaq.html
.. _SourceForge: http://sourceforge.net/tracker/?group_id=5470&atid=105470


More information about the Python-Dev mailing list