mozilla

Compare Revisions

Bug writing guidelines

Change Revisions

Revision 12867:

Revision 12867 by Chrisblore on

Revision 12868:

Revision 12868 by Chrisblore on

Title:
Bug writing guidelines
Bug writing guidelines
Slug:
Bug_writing_guidelines
Bug_writing_guidelines
Tags:
QA, Bugzilla
QA, Bugzilla
Content:

Revision 12867
Revision 12868
t55    <pre class="eval">t55    <p>
56       Severity: How damaging is the bug?
57       This item defaults to 'normal'. (To determine the most app56      Severity: How damaging is the bug? This item defaults to 'n
>ropriate severity for a particular bug, click on the Severity lin>ormal'. (To determine the most appropriate severity for a particu
>k for a full explanation of each choice, from Critical to Enhance>lar bug, click on the Severity link for a full explanation of eac
>ment.)>h choice, from Critical to Enhancement.)
58</pre>57    </p>
59    <pre class="eval">58    <p>
60   Who will be following up on the bug?59      Who will be following up on the bug?
61</pre>60    </p>
62    <pre class="eval">61    <p>
63       Assigned To: Which engineer should be responsible for fixi62      Assigned To: Which engineer should be responsible for fixin
>ng this bug?>g this bug? Bugzilla will automatically assign the bug to a defau
 >lt engineer upon submitting a bug report; the text box exists to 
 >allow you to manually assign it to a different engineer. (To see 
 >the list of default engineers for each component, click on the Co
 >mponent link.) Cc: Who else should receive e-mail updates on chan
 >ges to this bug? List the full e-mail addresses of other individu
 >als who should receive an e-mail update upon every change to the 
 >bug report. You can enter as many e-mail addresses as you'd like;
 > e-mail addresses must be separated by commas, with no spaces bet
 >ween the addresses.
64       Bugzilla will automatically assign the bug to a default en63    </p>
>gineer upon submitting a bug report; the text box exists to allow 
> you to manually assign it to a different engineer. (To see the l 
>ist of default engineers for each component, click on the Compone 
>nt link.) 
65       Cc: Who else should receive e-mail updates on changes to t64    <p>
>his bug? 
66       List the full e-mail addresses of other individuals who sh
>ould receive an e-mail update upon every change to the bug report 
>. You can enter as many e-mail addresses as you'd like; e-mail ad 
>dresses must be separated by commas, with no spaces between the a 
>ddresses. 
67       You would not normally change either of these fields from 65      You would not normally change either of these fields from t
>their default values.>heir default values.
68</pre>66    </p>
69    <pre class="eval">67    <p>
70   What else can you tell the engineer about the bug?68      What else can you tell the engineer about the bug?
71</pre>69    </p>
72    <pre class="eval">70    <p>
73       URL: On what URL did you discover this bug?71      URL: On what URL did you discover this bug? If you encounte
 >red the bug on a particular URL, please provide it (or, them) her
 >e. If you've isolated the bug to a specific HTML snippet, please 
 >also provide a URL for that, too or, preferably, return to the bu
 >g after you've submitted it and add the HTML snippet as an attach
 >ment.
74       If you encountered the bug on a particular URL, please pro72    </p>
>vide it (or, them) here. If you've isolated the bug to a specific 
> HTML snippet, please also provide a URL for that, too or, prefer 
>ably, return to the bug after you've submitted it and add the HTM 
>L snippet as an attachment. 
75       Summary: How would you describe the bug, in approximately 73    <p>
>60 or fewer characters? 
76       A good summary should quickly and uniquely identify a bug 74      Summary: How would you describe the bug, in approximately 6
>report. Otherwise, developers cannot meaningfully query by bug su>0 or fewer characters? A good summary should quickly and uniquely
>mmary, and will often fail to pay attention to your bug report wh> identify a bug report. Otherwise, developers cannot meaningfully
>en reviewing a 10 page bug list. Think of it as a "title".> query by bug summary, and will often fail to pay attention to yo
 >ur bug report when reviewing a 10 page bug list. Think of it as a
 > "title". A summary of "Drag-scrolling any web page crashes Mac O
 >S X builds" is a useful title. "Crash" or "Drag Crash" would be e
 >xamples of a bad title.
77       A summary of "Drag-scrolling any web page crashes Mac OS X75    </p>
> builds" is a useful title. "Crash" or "Drag Crash" would be exam 
>ples of a bad title. 
78       Description: What else can you tell the engineer about thi76    <p>
>s bug? 
79       Please provide as detailed of a problem diagnosis in this 77      Description: What else can you tell the engineer about this
>field as possible, including as much as possible of the following> bug? Please provide as detailed of a problem diagnosis in this f
> information:>ield as possible, including as much as possible of the following 
 >information:
80</pre>78    </p>
81    <pre class="eval">79    <p>
82           Overview Description: More detailed expansion of summa80      Overview Description: More detailed expansion of summary. D
>ry.>rag-selecting any page crashes Mac OS X builds in NSGetFactory St
 >eps to Reproduce: The minimal set of steps necessary to trigger t
 >he bug. Include any special setup steps. 1) View any web page. (I
 > used the default sample page, resource:/res/samples/test0.html) 
 >2) Drag-select the page. (Specifically, while holding down the mo
 >use button, drag the mouse pointer downwards from any point in th
 >e browser's content region to the bottom of the browser's content
 > region.)
83</pre>81    </p>
84    <pre class="eval">82    <p>
85               Drag-selecting any page crashes Mac OS X builds in
> NSGetFactory 
86</pre>
87    <pre class="eval">
88           Steps to Reproduce: The minimal set of steps necessary
> to trigger the bug. Include any special setup steps. 
89</pre>
90    <pre class="eval">
91               1) View any web page. (I used the default sample p
>age, resource:/res/samples/test0.html) 
92               2) Drag-select the page. (Specifically, while hold
>ing down the mouse button, drag the mouse pointer downwards from  
>any point in the browser's content region to the bottom of the br 
>owser's content region.) 
93</pre>
94    <pre class="eval">
95           Actual Results: What the application did after perform83      Actual Results: What the application did after performing t
>ing the above steps.>he above steps.
96</pre>84    </p>
97    <pre class="eval">85    <p>
98               The application crashed. Stacktrace appended below86      The application crashed. Stacktrace appended below from gdb
> from gdb.>.
99</pre>87    </p>
100    <pre class="eval">88    <p>
101           Expected Results: What the application should have don89      Expected Results: What the application should have done, we
>e, were the bug not present.>re the bug not present. The window should scroll downwards. Scrol
 >led content should be selected. (Or, at least, the application sh
 >ould not crash.)
102</pre>90    </p>
103    <pre class="eval">91    <p>
104               The window should scroll downwards. Scrolled conte
>nt should be selected. (Or, at least, the application should not  
>crash.) 
105</pre>
106    <pre class="eval">
107           Build Date &amp; Platform: Date and platform of the bu92      Build Date &amp; Platform: Date and platform of the build t
>ild that you first encountered the bug in. (The build date can be>hat you first encountered the bug in. (The build date can be foun
> found as part of the window title, in YYYYMMddHH format.)>d as part of the window title, in YYYYMMddHH format.) 2003060709 
 >installer build on Mac OS X
108</pre>93    </p>
109    <pre class="eval">94    <p>
110               2003060709 installer build on Mac OS X
111</pre>
112    <pre class="eval">
113           Additional Builds and Platforms: Whether or not the bu95      Additional Builds and Platforms: Whether or not the bug tak
>g takes place on other platforms or browsers.>es place on other platforms or browsers.
114</pre>96    </p>
115    <pre class="eval">97    <p>
116               - Occurs On Seamonkey (20030605 build on Windows 298      - Occurs On Seamonkey (20030605 build on Windows 2000) - Do
>000)>esn't Occur On Seamonkey (20030602 build on Suse Linux), IE 6 (Wi
 >ndows XP), Netscape Navigator 4.5 (Mac OS) Additional Information
 >: Minimized HTML snippets, Talkback crash IDs, and any other debu
 >gging information. For crashing bugs:
117               - Doesn't Occur On Seamonkey (20030602 build on Su99    </p>
>se Linux), IE 6 (Windows XP), Netscape Navigator 4.5 (Mac OS) 
118</pre>100    <ul>
119    <pre class="eval">
120           Additional Information: Minimized HTML snippets, Talkb
>ack crash IDs, and any other debugging information. For crashing  
>bugs: 
121</pre>
122    <pre class="eval">
123               * Win32: If you receive a Dr. Watson error, please101      <li>Win32: If you receive a Dr. Watson error, please note t
> note the type of the crash, and the module that the application >he type of the crash, and the module that the application crashed
>crashed in. (e.g. access violation in mozilla.exe)> in. (e.g. access violation in mozilla.exe)
102      </li>
124               * Mac OS: If you're running MacsBug, please provid103      <li>Mac OS: If you're running MacsBug, please provide the r
>e the results of a how and an sc.>esults of a how and an sc.
104      </li>
125               * Unix: Please provide a minimized stack trace, wh105      <li>Unix: Please provide a minimized stack trace, which can
>ich can be generated by typing gdb mozilla core into a shell prom> be generated by typing gdb mozilla core into a shell prompt.
>pt. 
126</pre>106      </li>
127    <pre class="eval">107    </ul>
108    <ul>
109      <li>
110        <ul>
111          <li>
112            <ul>
128               *** MACSBUG STACK CRAWL OF CRASH (Mac OS)113              <li>MACSBUG STACK CRAWL OF CRASH (Mac OS)
129               Calling chain using A6/R1 links114              </li>
130               Back chain ISA Caller115            </ul>
131               00000000 PPC 0BA85E74116          </li>
132               03AEFD80 PPC 0B742248117        </ul>
133               03AEFD30 PPC 0B50FddC NSGetFactory+027FC118      </li>
134               PowerPC unmapped memory exception at119    </ul>
135               0B512BD0 NSGetFactory+055F0120    <p>
136</pre>121      Calling chain using A6/R1 links Back chain ISA Caller 00000
 >000 PPC 0BA85E74 03AEFD80 PPC 0B742248 03AEFD30 PPC 0B50FddC NSGe
 >tFactory+027FC PowerPC unmapped memory exception at 0B512BD0 NSGe
 >tFactory+055F0
137    <pre class="eval">122    </p>
123    <p>
138       You're done!124      You're done!
139</pre>125    </p>
140    <pre class="eval">126    <p>
141       After double-checking your entries for any possible errors127      After double-checking your entries for any possible errors,
>, press the "Commit" button, and your bug report will be part of > press the "Commit" button, and your bug report will be part of t
>the Bugzilla database.>he Bugzilla database.
142</pre>128    </p>
129    <p>
130      (The Mozilla QA Bug Writing Guidelines were originally writ
 >ten by Eli Goldberg. Thanks to Claudius Gayle, Jan Leger, Peter M
 >ock, Chris Pratt, Chris Yeh and Felix Miata for contributing to t
 >his document. Additional suggestions welcome.)
131    </p>

Back to History