n | ************** |
n | .. _reporting-bugs: |
| Reporting Bugs |
| ************** |
| |
n | .. _reporting-bugs: |
n | ************************ |
| Reporting Bugs in Python |
| ************************ |
| |
| Python is a mature programming language which has established a reputation for |
| stability. In order to maintain this reputation, the developers would like to |
n | know of any deficiencies you find in Python or its documentation. |
n | know of any deficiencies you find in Python. |
| |
n | Before submitting a report, you will be required to log into SourceForge; this |
| will make it possible for the developers to contact you for additional |
| information if needed. It is not possible to submit a bug report anonymously. |
| |
| All bug reports should be submitted via the Python Bug Tracker on SourceForge |
| Bug reports should be submitted via the Python Bug Tracker |
| (`<http://sourceforge.net/bugs/?group_id=5470>`_). The bug tracker offers a Web |
| (http://bugs.python.org/). The bug tracker offers a Web form which allows |
| form which allows pertinent information to be entered and submitted to the |
| pertinent information to be entered and submitted to the developers. |
| developers. |
| |
| 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!). |
n | To do this, search the bug database using the search box on the left side of the |
n | To do this, search the bug database using the search box on the top of the page. |
| page. |
| |
| If the problem you're reporting is not already in the bug tracker, go back to |
n | the Python Bug Tracker (`<http://sourceforge.net/bugs/?group_id=5470>`_). |
n | the Python Bug Tracker. If you don't already have a tracker account, select the |
| Select the "Submit a Bug" link at the top of the page to open the bug reporting |
| "Register" link in the sidebar and undergo the registration procedure. |
| form. |
| Otherwise, if you're not logged in, enter your credentials and select "Login". |
| It is not possible to submit a bug report anonymously. |
| |
n | The submission form has a number of fields. The only fields that are required |
n | Being now logged in, you can submit a bug. Select the "Create New" link in the |
| are the "Summary" and "Details" fields. For the summary, enter a *very* short |
| sidebar to open the bug reporting form. |
| |
| The submission form has a number of fields. For the "Title" field, enter a |
| description of the problem; less than ten words is good. In the Details field, |
| *very* short description of the problem; less than ten words is good. In the |
| describe the problem in detail, including what you expected to happen and what |
| "Type" field, select the type of your problem; also select the "Component" and |
| did happen. Be sure to include the version of Python you used, whether any |
| "Versions" to which the bug relates. |
| |
| 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). |
n | |
| The only other field that you may want to set is the "Category" field, which |
| allows you to place the bug report into a broad category (such as |
| "Documentation" or "Library"). |
| |
| 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. |
| |
| |
| .. seealso:: |
| |
n | `How to Report Bugs Effectively <http://www-mice.cs.ucl.ac.uk/multimedia/software/documentation/ReportingBugs.html>`_ |
n | `How to Report Bugs Effectively <http://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_ |
| 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. |
| |
t | `Bug Writing Guidelines <http://www.mozilla.org/quality/bug-writing-guidelines.html>`_ |
t | `Bug Writing Guidelines <http://developer.mozilla.org/en/docs/Bug_writing_guidelines>`_ |
| Information about writing a good bug report. Some of this is specific to the |
| Mozilla project, but describes general good practices. |
| |