Compare Revisions

Bug writing guidelines

Change Revisions

Revision 12877:

Revision 12877 by Sheppy on

Revision 12878:

Revision 12878 by Sheppy on

Bug writing guidelines
Bug writing guidelines
QA, Bugzilla
QA, Bugzilla

Revision 12877
Revision 12878
n7    <h2 name="Why_You_Should_Read_This">n7    <h2 name="Why_you_should_read_this">
8      Why You Should Read This8      Why you should read this
n13    <h2 name="How_to_Write_a_Useful_Bug_Report">n13    <h2 name="How_to_write_a_useful_bug_report">
14      How to Write a Useful Bug Report14      How to write a useful bug report
nn29      <b>BAD</b>: "My browser crashed. I think I was on 
 >I think that this is a really bad problem and you should fix it o
 >r else nobody will use your browser. By the way, my sister thinks
 > your icons really suck. Oh, and my mom's home page doesn't look 
 >right, either, it's all messed up. Thx 4 fixing theze bugz."
30    </p>
31    <p>
29      <b>BAD</b>: "My browser crashed. I think I was on 32      <b>GOOD</b>: "I crashed each time when I went to, u
>I think that this is a really bad problem and you should fix it o>sing Mozilla on a Win NT 4.0 (Service Pack 5) system. The build I
>r else nobody will use your browser. By the way, my sister thinks>D is 20030609. I also rebooted into Linux, and reproduced this pr
> your icons really suck. Oh, and my mom's home page doesn't look >oblem using the 20030608 Linux build. Mozilla crashed each time u
>right, either, it's all messed up. Thx 4 fixing theze bugz." <b>G>pon drawing the Foo banner at the top of the page. I broke apart 
>OOD</b>: "I crashed each time when I went to, using Mozil>the page, and discovered that the following image link will crash
>la on a Win NT 4.0 (Service Pack 5) system. The build ID is 20030> Mozilla reproducibly, unless you remove the "border=0" attribute
>609. I also rebooted into Linux, and reproduced this problem usin><span class="plain">&lt;IMG SRC="
>g the 20030608 Linux build. Mozilla crashed each time upon drawin>opicfoos.gif" width=34 height=44 border=0 alt="News"&gt;</span>
>g the Foo banner at the top of the page. I broke apart the page,  
>and discovered that the following image link will crash Mozilla r 
>eproducibly, unless you remove the "border=0" attribute: &lt;IMG  
>SRC="" width=34 height= 
>44 border=0 alt="News"&gt; 
nn40    <h2 name="How_to_enter_your_useful_bug_report_into_Bugzilla">
41      How to enter your useful bug report into Bugzilla
42    </h2>
n38      How to Enter your Useful Bug Report into Bugzillan44      Before you enter your bug, you need to make sure it has not
 > been previously reported. There is a <a class="external" href="h
 >orial</a> on the best ways of doing this.
39    </p>
40    <p>
41      Before you enter your bug, you need to make sure it has not
> been previously reported. There is a tutorial on the best ways o 
>f doing this. 
n47      1. Are you sure you don't want to use the guided form?&nbspn50      1. Are you sure you don't want to use the guided form? You 
>;:-) You won't have to read the rest of this page if you do... 2.>won't have to read the rest of this page if you do.
> OK, then. From the Bugzilla main page (http://bugzilla.mozilla.o 
>rg), choose "Enter a new bug". 3. Select the product that you've  
>found a bug in. 4. If you haven't logged into Bugzilla already, y 
>ou'll need to enter your email address, password, and press the " 
>Login" button. (If you don't yet have a password, enter your emai 
>l address below and press the "Submit Request" button instead. Yo 
>u'll receive an email message with your password shortly.) 
51    </p>
52    <p>
53      2. Okay, then. From the Bugzilla main page (http://bugzilla
 >, choose "Enter a new bug".
54    </p>
55    <p>
56      3. Select the product that you've found a bug in.
57    </p>
58    <p>
59      4. If you haven't logged into Bugzilla already, you'll need
 > to enter your email address and password, then press the "Login"
 > button. (If you don't yet have a password, enter your email addr
 >ess below and press the "Submit Request" button instead. You'll r
 >eceive an email message with your password shortly.)
nn64    <h3 name="Where_did_you_find_the_bug.3F">
65      Where did you find the bug?
66    </h3>
n53      Where did you find the bug?n68      <b>Product:</b> In which product did you find the bug? You 
 >just filled this out on the last page.
n56      Product: In which product did you find the bug? You just fin71      <b>Version:</b> In which product version did you find the b
>lled this out on the last page. Version: In which product version>ug? We're not yet using this field. Just leave the default value 
> did you find the bug? We're not yet using this field. Just leave>as you found it.&nbsp;;)
> the default value as you found it.&nbsp;;) Component: In which c 
>omponent does the bug exist? Bugzilla requires that you select a  
>component to enter a bug. (If they all look meaningless, click on 
> the Component link, which links to descriptions of each componen 
>t, to help you make the best choice.) Platform: On which hardware 
> platform did you find this bug? (e.g. Macintosh, SGI, Sun, PC.)  
>If you know the bug happens on all hardware platforms, choose 'Al 
>l'. Otherwise, select the platform that you found the bug on, or  
>"Other" if your platform isn't listed. OS: On which Operating Sys 
>tem (OS) did you find this bug? (e.g. Linux, Windows NT, Mac OS X 
>) If you know the bug happens on all OSs, choose 'All'. Otherwise 
>, select the OS that you found the bug on, or "Other" if your OS  
>isn't listed. 
n59      How important is the bug?n74      <b>Component:</b> In which component does the bug exist?
n62      Severity: How damaging is the bug? This item defaults to 'nn77      Bugzilla requires that you select a component to enter a bu
>ormal'. (To determine the most appropriate severity for a particu>g. (If they all look meaningless, click on the Component link, wh
>lar bug, click on the Severity link for a full explanation of eac>ich links to descriptions of each component, to help you make the
>h choice, from Critical to Enhancement.)> best choice.)
n65      Who will be following up on the bug?n80      <b>Platform:</b> On which hardware platform did you find th
 >is bug? (e.g. Macintosh, SGI, Sun, PC.) If you know the bug happe
 >ns on all hardware platforms, choose 'All'. Otherwise, select the
 > platform that you found the bug on, or "Other" if your platform 
 >isn't listed.
n68      Assigned To: Which engineer should be responsible for fixinn83      <b>OS:</b> On which Operating System (OS) did you find this
>g this bug? Bugzilla will automatically assign the bug to a defau> bug? (e.g. Linux, Windows NT, Mac OS X) If you know the bug happ
>lt engineer upon submitting a bug report; the text box exists to >ens on all OSs, choose 'All'. Otherwise, select the OS that you f
>allow you to manually assign it to a different engineer. (To see >ound the bug on, or "Other" if your OS isn't listed.
>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. 
84    </p>
85    <h3 name="How_important_is_the_bug.3F">
86      How important is the bug?
87    </h3>
88    <p>
89      <b>Severity:</b> How damaging is the bug? This item default
 >s to "normal". (To determine the most appropriate severity for a 
 >particular bug, click on the Severity link for a full explanation
 > of each choice, from Critical to Enhancement.)
90    </p>
91    <h3 name="Who_will_be_following_up_on_the_bug.3F">
92      Who will be following up on the bug?
93    </h3>
94    <p>
95      <b>Assigned To:</b> Which engineer should be responsible fo
 >r fixing this bug?
n71      You would not normally change either of these fields from tn98      Bugzilla will automatically assign the bug to a default eng
>heir default values.>ineer based on the component when you submit the bug report; this
 > text box lets you manually assign it to a different engineer. (T
 >o see the list of default engineers for each component, click on 
 >the Component link.)
nn101      <b>Cc:</b> Who else should receive e-mail updates on change
 >s to this bug? List the full e-mail addresses of other individual
 >s who should receive an e-mail update upon every change to the bu
 >g report. You can enter as many e-mail addresses as you'd like; e
 >-mail addresses must be separated by commas, with no spaces betwe
 >en the addresses.
102    </p>
103    <div class="tip">
104      You would not normally change either of these fields from t
 >heir default values.
105    </div>
106    <h3 name="What_else_can_you_tell_the_engineer_about_the_bug.3
nn108    </h3>
109    <p>
110      <b>URL:</b> On what URL did you discover this bug? If you e
 >ncountered the bug on a particular URL, please provide it (or, th
 >em) here. If you've isolated the bug to a specific HTML snippet, 
 >please also provide a URL for that, too or, preferably, return to
 > the bug after you've submitted it and add the HTML snippet as an
 > attachment.
n77      URL: On what URL did you discover this bug? If you encounten113      <b>Summary:</b> How would you describe the bug, in approxim
>red the bug on a particular URL, please provide it (or, them) her>ately 60 or fewer characters? A good summary should quickly and u
>e. If you've isolated the bug to a specific HTML snippet, please >niquely identify a bug report. Otherwise, developers cannot meani
>also provide a URL for that, too or, preferably, return to the bu>ngfully query by bug summary, and will often fail to pay attentio
>g after you've submitted it and add the HTML snippet as an attach>n to your bug report when reviewing a 10 page bug list. Think of 
>ment.>it as a "title".
n80      Summary: How would you describe the bug, in approximately 6n116      A summary like "Drag-scrolling any web page crashes Mac OS 
>0 or fewer characters? A good summary should quickly and uniquely>X builds" is a useful title. "Crash" or "Drag Crash" would be exa
> identify a bug report. Otherwise, developers cannot meaningfully>mples of a bad 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. 
n83      Description: What else can you tell the engineer about thisn119      <b>Description:</b> What else can you tell the engineer abo
> bug? Please provide as detailed of a problem diagnosis in this f>ut this bug? Please provide as detailed of a problem diagnosis in
>ield as possible, including as much as possible of the following > this field as possible, using the following example as a templat
>information:>e to go by:
tt121    <div class="highlight">
85    <p>122      <p>
86      Overview Description: More detailed expansion of summary. D123        Overview Description: More detailed expansion of summary.
>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.) 
87    </p>124      </p>
88    <p>125      <p>
126        Drag-selecting any page crashes Mac OS X builds in NSGetF
127      </p>
128      <p>
129        Steps to Reproduce: The minimal set of steps necessary to
 > trigger the bug. Include any special setup steps. 1) View any we
 >b page. (I used the default sample page, resource:/res/samples/te
 >st0.html) 2) Drag-select the page. (Specifically, while holding d
 >own the mouse button, drag the mouse pointer downwards from any p
 >oint in the browser's content region to the bottom of the browser
 >'s content region.)
130      </p>
131      <p>
89      Actual Results: What the application did after performing t132        Actual Results: What the application did after performing
>he above steps.> the above steps.
90    </p>133      </p>
91    <p>134      <p>
92      The application crashed. Stacktrace appended below from gdb135        The application crashed. Stacktrace appended below from g
93    </p>136      </p>
94    <p>137      <p>
95      Expected Results: What the application should have done, we138        Expected Results: What the application should have done, 
>re the bug not present. The window should scroll downwards. Scrol>were the bug not present. The window should scroll downwards. Scr
>led content should be selected. (Or, at least, the application sh>olled content should be selected. (Or, at least, the application 
>ould not crash.)>should not crash.)
96    </p>139      </p>
97    <p>140      <p>
98      Build Date &amp; Platform: Date and platform of the build t141        Build Date &amp; Platform: Date and platform of the build
>hat you first encountered the bug in. (The build date can be foun> that you first encountered the bug in. (The build date can be fo
>d as part of the window title, in YYYYMMddHH format.) 2003060709 >und as part of the window title, in YYYYMMddHH format.) 200306070
>installer build on Mac OS X>9 installer build on Mac OS X
99    </p>142      </p>
100    <p>143      <p>
101      Additional Builds and Platforms: Whether or not the bug tak144        Additional Builds and Platforms: Whether or not the bug t
>es place on other platforms or browsers.>akes place on other platforms or browsers.
102    </p>145      </p>
103    <p>146      <p>
104      - Occurs On Seamonkey (20030605 build on Windows 2000) - Do147        - Occurs On Seamonkey (20030605 build on Windows 2000) - 
>esn't Occur On Seamonkey (20030602 build on Suse Linux), IE 6 (Wi>Doesn't Occur On Seamonkey (20030602 build on Suse Linux), IE 6 (
>ndows XP), Netscape Navigator 4.5 (Mac OS) Additional Information>Windows XP), Netscape Navigator 4.5 (Mac OS) Additional Informati
>: Minimized HTML snippets, Talkback crash IDs, and any other debu>on: Minimized HTML snippets, Talkback crash IDs, and any other de
>gging information. For crashing bugs:>bugging information. For crashing bugs:
105    </p>148      </p>
106    <ul>149      <ul>
107      <li>Win32: If you receive a Dr. Watson error, please note t150        <li>Win32: If you receive a Dr. Watson error, please note
>he type of the crash, and the module that the application crashed> the type of the crash, and the module that the application crash
> in. (e.g. access violation in mozilla.exe)>ed in. (e.g. access violation in mozilla.exe)
108      </li>151        </li>
109      <li>Mac OS: If you're running MacsBug, please provide the r152        <li>Mac OS: If you're running MacsBug, please provide the
>esults of a how and an sc.> results of a how and an sc.
110      </li>153        </li>
111      <li>Unix: Please provide a minimized stack trace, which can154        <li>Unix: Please provide a minimized stack trace, which c
> be generated by typing gdb mozilla core into a shell prompt.>an be generated by typing <tt>gdb mozilla core</tt> into a shell 
112      </li>
113    </ul>
114    <ul>
115      <li>
116        <ul>
117          <li>
118            <ul>
119              <li>MACSBUG STACK CRAWL OF CRASH (Mac OS)
120              </li>
121            </ul>
122          </li>155        </li>
123        </ul>156      </ul>
124      </li>
125    </ul>
126    <p>157      <p>
127      Calling chain using A6/R1 links Back chain ISA Caller 00000158        <span class="plain">*** MACSBUG STACK CRAWL OF CRASH (Mac
>000 PPC 0BA85E74 03AEFD80 PPC 0B742248 03AEFD30 PPC 0B50FddC NSGe> OS)</span><br>
>tFactory+027FC PowerPC unmapped memory exception at 0B512BD0 NSGe 
159        Calling chain using A6/R1 links<br>
160        Back chain ISA Caller<br>
161        00000000 PPC 0BA85E74<br>
162        03AEFD80 PPC 0B742248<br>
163        03AEFD30 PPC 0B50FddC NSGetFactory+027FC<br>
164        PowerPC unmapped memory exception at<br>
165        0B512BD0 NSGetFactory+055F0<br>
128    </p>166      </p>
167    </div>

Back to History