|
| 1 | +\label{reporting-bugs} |
| 2 | + |
| 3 | +Python is a mature programming language which has established a |
| 4 | +reputation for stability. In order to maintain this reputation, the |
| 5 | +developers would like to know of any deficiencies you find in Python |
| 6 | +or its documentation. |
| 7 | + |
| 8 | +All bug reports should be submitted via the Python Bug Tracker on |
| 9 | +SourceForge (\url{http://sourceforge.net/bugs/?group_id=5470}). The |
| 10 | +bug tracker offers a Web form which allows pertinent information to be |
| 11 | +entered and submitted to the developers. |
| 12 | + |
| 13 | +Before submitting a report, please log into SourceForge if you are a |
| 14 | +member; this will make it possible for the developers to contact you |
| 15 | +for additional information if needed. If you are not a SourceForge |
| 16 | +member but would not mind the developers contacting you, you may |
| 17 | +include your email address in your bug description. In this case, |
| 18 | +please realize that the information is publically available and cannot |
| 19 | +be protected. |
| 20 | + |
| 21 | +The first step in filing a report is to determine whether the problem |
| 22 | +has already been reported. The advantage in doing so, aside from |
| 23 | +saving the developers time, is that you learn what has been done to |
| 24 | +fix it; it may be that the problem has already been fixed for the next |
| 25 | +release, or additional information is needed (in which case you are |
| 26 | +welcome to provide it if you can!). To do this, search the bug |
| 27 | +database using the search box near the bottom of the page. |
| 28 | + |
| 29 | +If the problem you're reporting is not already in the bug tracker, go |
| 30 | +back to the Python Bug Tracker |
| 31 | +(\url{http://sourceforge.net/bugs/?group_id=5470}). Select the |
| 32 | +``Submit a Bug'' link at the top of the page to open the bug reporting |
| 33 | +form. |
| 34 | + |
| 35 | +The submission form has a number of fields. The only fields that are |
| 36 | +required are the ``Summary'' and ``Details'' fields. For the summary, |
| 37 | +enter a \emph{very} short description of the problem; less than ten |
| 38 | +words is good. In the Details field, describe the problem in detail, |
| 39 | +including what you expected to happen and what did happen. Be sure to |
| 40 | +include the version of Python you used, whether any extension modules |
| 41 | +were involved, and what hardware and software platform you were using |
| 42 | +(including version information as appropriate). |
| 43 | + |
| 44 | +The only other field that you may want to set is the ``Category'' |
| 45 | +field, which allows you to place the bug report into a broad category |
| 46 | +(such as ``Documentation'' or ``Library''). |
| 47 | + |
| 48 | +Each bug report will be assigned to a developer who will determine |
| 49 | +what needs to be done to correct the problem. If you have a |
| 50 | +SourceForge account and logged in to report the problem, you will |
| 51 | +receive an update each time action is taken on the bug. |
| 52 | + |
| 53 | + |
| 54 | +\begin{seealso} |
| 55 | + \seetitle[http://www-mice.cs.ucl.ac.uk/multimedia/software/documentation/ReportingBugs.html]{How |
| 56 | + to Report Bugs Effectively}{Article which goes into some |
| 57 | + detail about how to create a useful bug report. This |
| 58 | + describes what kind of information is useful and why it is |
| 59 | + useful.} |
| 60 | + |
| 61 | + \seetitle[http://www.mozilla.org/quality/bug-writing-guidelines.html]{Bug |
| 62 | + Writing Guidelines}{Information about writing a good bug |
| 63 | + report. Some of this is specific to the Mozilla project, but |
| 64 | + describes general good practices.} |
| 65 | +\end{seealso} |
0 commit comments