Description
|
Size: 1038
Comment:
|
Size: 1655
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| The bug description is one of the first things seen, and hopefully read, by any Launchpad user looking at bug reports. Therefore we should try to use the bug description as a means of communicating useful information about the bug. This will prevent the need for Launchpad users to read every single bug comment. | [[Include(BugSquad/KBHeader)]] The bug description is one of the first things seen, and hopefully read, by any Launchpad user looking at bug reports. Therefore we should try to use the bug description as a means of communicating useful information about the bug. This will prevent the need for Launchpad users, be they developers or bug reporters, to read every single bug comment. |
| Line 3: | Line 4: |
| There should also be some standard items to include in the bug description and they should be identifiable using by using the same keywords. Below is a table of suggested modifications. | There should be some standard items to include in the bug description and they should be identifiable by using the same keywords. The keywords should also be formatted so that they are easy to spot visually. The suggested formatting is using a blank line before the keyword and all capital letters for the keyword - e.g. "TEST CASE". The table below contains the standard modifications. |
| Line 5: | Line 6: |
| || Keyword || Use case || || TEST CASE || Steps to recreate the bug report. || || LATEST PACKAGE TESTED || latest package version to experience the bug - useful for old bugs or ones with newer duplicates || || ISO TESTED || Specific CD image used when finding a bug - particularly useful for daily builds and milestones || || WORKAROUND || Steps to avoid the bug or resolve it without an updated package || || NEXT STEP || What needs to happen next with the bug? Useful for multi-reporter bugs so they know how to help. || |
||<rowbgcolor="#FFEBBB"> '''Keyword''' || '''Use case''' || || Test Case || Steps to recreate the bug report. || || Lastest Package Tested || Latest package version to experience the bug - useful for old bugs or ones with newer duplicates || || ISO Tested || Specific CD image used when finding a bug - particularly useful for daily builds and milestones || || Workaround || Steps to avoid the bug or resolve it without an updated package - bugs with workarounds are not fixed. || || Next Step || What needs to happen next with the bug? Useful for multi-reporter bugs so they know how to help. || Examples: [http://launchpad.net/bugs/147772 bug 147772] [http://launchpad.net/bugs/204133 bug 204133] [http://launchpad.net/bugs/190029 bug 190029] [http://launchpad.net/bugs/141613 bug 141613] [http://launchpad.net/bugs/201673 bug 201673] ---- CategoryBugSquad |
Include(BugSquad/KBHeader) The bug description is one of the first things seen, and hopefully read, by any Launchpad user looking at bug reports. Therefore we should try to use the bug description as a means of communicating useful information about the bug. This will prevent the need for Launchpad users, be they developers or bug reporters, to read every single bug comment.
There should be some standard items to include in the bug description and they should be identifiable by using the same keywords. The keywords should also be formatted so that they are easy to spot visually. The suggested formatting is using a blank line before the keyword and all capital letters for the keyword - e.g. "TEST CASE". The table below contains the standard modifications.
Keyword |
Use case |
Test Case |
Steps to recreate the bug report. |
Lastest Package Tested |
Latest package version to experience the bug - useful for old bugs or ones with newer duplicates |
ISO Tested |
Specific CD image used when finding a bug - particularly useful for daily builds and milestones |
Workaround |
Steps to avoid the bug or resolve it without an updated package - bugs with workarounds are not fixed. |
Next Step |
What needs to happen next with the bug? Useful for multi-reporter bugs so they know how to help. |
Examples:
[http://launchpad.net/bugs/147772 bug 147772] [http://launchpad.net/bugs/204133 bug 204133] [http://launchpad.net/bugs/190029 bug 190029] [http://launchpad.net/bugs/141613 bug 141613] [http://launchpad.net/bugs/201673 bug 201673]
Bugs/Description (last edited 2010-06-16 22:19:28 by OL118-71)