Compare Revisions

Bug writing guidelines

Change Revisions

Revision 12885:

Revision 12885 by Nickolay on

Revision 12886:

Revision 12886 by Nickolay on

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

Revision 12885
Revision 12886
nn59    <div class="note">
59    <p>60      <p>
60      Before you enter your bug, you need to make sure it has not61        Before you enter your bug, you need to make sure it has n
> been previously reported. There is a <a class="external" href="h>ot been previously reported. There is a <a class="external" href=
>orial</a> on the best ways of doing this.>utorial</a> on the best ways of doing this.
62      </p>
63    </div>
61    </p>64    <p>
65      Next, be sure that you've reproduced your bug using a build
 > released within the past three days. Our development process mov
 >es at lightning speed, and the bug you've found may already have 
 >been fixed. (Nightly builds can be downloaded from ftp.mozilla.or
 >g, see <a class="external" href="
 >/#builds">for specific links.)</a>
62    <p>66    </p>
63      Next, be sure that you've reproduced your bug using a build
> released within the past three days. Our development process mov 
>es at lightning speed, and the bug you've found may already have  
>been fixed. (Nightly builds can be downloaded from the mozilla.or 
>g binaries page.) If you've discovered a new bug using a current  
>build, report it in the guided Bugzilla entry form. 
64    </p>67    <p>
68      <a class="external" href="
 >#builds">If you've discovered a new bug using a current build, re
 >port it in the</a> <a class="external" href="https://bugzilla.moz
 >">guided Bugzilla entry form<
65    <p>69    </p>
70    <ol>
66      1. Are you sure you don't want to use the guided form? You 71      <li>Are you sure you don't want to use the guided form? You
>won't have to read the rest of this page if you do.> won't have to read the rest of this page if you do.
67    </p>72      </li>
68    <p>
69      2. Okay, then. From the Bugzilla main page (http://bugzilla73      <li>Okay, then. From the Bugzilla main page (https://bugzil
>, choose "Enter a new bug".>, choose "Enter a new bug".
70    </p>74      </li>
71    <p>
72      3. Select the product that you've found a bug in.75      <li>Select the product that you've found a bug in.
73    </p>76      </li>
74    <p>
75      4. If you haven't logged into Bugzilla already, you'll need77      <li>If you haven't logged into Bugzilla already, you'll nee
> to enter your email address and password, then press the "Login">d to enter your email address and password, then press the "Login
> button. (If you don't yet have a password, enter your email addr>" button. (If you don't yet have a password, enter your email add
>ess below and press the "Submit Request" button instead. You'll r>ress below and press the "Submit Request" button instead. You'll 
>eceive an email message with your password shortly.)>receive an email message with your password shortly.)
78      </li>
76    </p>79    </ol>
n83    <p>n86    <dl>
84      <b>Product:</b> In which product did you find the bug? You 87      <dt>
>just filled this out on the last page. 
85    </p>88        <span class="plain">Product:</span> In which product did 
 >you find the bug?
86    <p>89      </dt>
87      <b>Version:</b> In which product version did you find the b90      <dd>
>ug? We're not yet using this field. Just leave the default value  
>as you found it.&nbsp;;) 
88    </p>91        You just filled this out on the last page.
89    <p>92      </dd>
93      <dt>
94        <span class="plain">Version:</span> In which product vers
 >ion did you find the bug?
95      </dt>
96      <dd>
97        We're not yet using this field. Just leave the default va
 >lue as you found it.&nbsp;;) <span class="comment">orly?</span>
98      </dd>
99      <dt>
90      <b>Component:</b> In which component does the bug exist?100        <span class="plain">Component:</span> In which component 
 >does the bug exist?
91    </p>101      </dt>
92    <p>102      <dd>
93      Bugzilla requires that you select a component to enter a bu103        Bugzilla requires that you select a component to enter a 
>g. (If they all look meaningless, click on the Component link, wh>bug. (If they all look meaningless, click on the Component link, 
>ich links to descriptions of each component, to help you make the>which links to descriptions of each component, to help you make t
> best choice.)>he best choice.)
104      </dd>
105      <dt>
106        <span class="plain">Platform:</span> On which hardware pl
 >atform did you find this bug? (e.g. Macintosh, SGI, Sun, PC.)
107      </dt>
108      <dd>
109        If you know the bug happens on all hardware platforms, ch
 >oose 'All'. Otherwise, select the platform that you found the bug
 > on, or "Other" if your platform isn't listed.
110      </dd>
111      <dt>
112        <span class="plain">OS:</span> On which Operating System 
 >(OS) did you find this bug? (e.g. Linux, Windows NT, Mac OS X)
113      </dt>
114      <dd>
115        If you know the bug happens on all OSs, choose 'All'. Oth
 >erwise, select the OS that you found the bug on, or "Other" if yo
 >ur OS isn't listed.
116      </dd>
94    </p>117    </dl>
95    <p>
96      <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. 
97    </p>
98    <p>
99      <b>OS:</b> On which Operating System (OS) did you find this
> bug? (e.g. Linux, Windows NT, Mac OS X) If you know the bug happ 
>ens on all OSs, choose 'All'. Otherwise, select the OS that you f 
>ound the bug on, or "Other" if your OS isn't listed. 
100    </p>
n104    <p>n121    <dl>
122      <dt>
123        <span class="plain">Severity:</span> How damaging is the 
124      </dt>
125      <dd>
105      <b>Severity:</b> How damaging is the bug? This item default126        This item defaults to "normal". (To determine the most ap
>s to "normal". (To determine the most appropriate severity for a >propriate severity for a particular bug, click on the Severity li
>particular bug, click on the Severity link for a full explanation>nk for a full explanation of each choice, from Critical to Enhanc
> of each choice, from Critical to Enhancement.)>ement.)
127      </dd>
106    </p>128    </dl>
n110    <p>n132    <dl>
133      <dt>
111      <b>Assigned To:</b> Which engineer should be responsible fo134        <span class="plain">Assigned To:</span> Which engineer sh
>r fixing this bug?>ould be responsible for fixing this bug?
112    </p>135      </dt>
113    <p>136      <dd>
114      Bugzilla will automatically assign the bug to a default eng137        Bugzilla will automatically assign the bug to a default e
>ineer based on the component when you submit the bug report; this>ngineer based on the component when you submit the bug report; th
> text box lets you manually assign it to a different engineer. (T>is text box lets you manually assign it to a different engineer. 
>o see the list of default engineers for each component, click on >(To see the list of default engineers for each component, click o
>the Component link.)>n the Component link.)
138      </dd>
139      <dt>
140        <span class="plain">Cc:</span> Who else should receive e-
 >mail updates on changes to this bug?
141      </dt>
142      <dd>
143        List the full e-mail addresses of other individuals who s
 >hould receive an e-mail update upon every change to the bug repor
 >t. You can enter as many e-mail addresses as you'd like; e-mail a
 >ddresses must be separated by commas, with no spaces between the 
144      </dd>
115    </p>145    </dl>
116    <p>
117      <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. 
118    </p>
119    <div class="tip">146    <div class="note">
n125    <p>n152    <dl>
126      <b>URL:</b> On what URL did you discover this bug? If you e153      <dt>
>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. 
127    </p>154        <span class="plain">URL:</span> On what URL did you disco
 >ver this bug?
128    <p>155      </dt>
156      <dd>
157        If you encountered the bug on a particular URL, please pr
 >ovide it (or, them) here. If you've isolated the bug to a specifi
 >c HTML snippet, please also provide a URL for that, too or, prefe
 >rably, return to the bug after you've submitted it and add the HT
 >ML snippet as an attachment.
158      </dd>
159      <dt>
160        <span class="plain">Summary:</span> How would you describ
 >e the bug, in approximately 60 or fewer characters?
161      </dt>
162      <dd>
129      <b>Summary:</b> How would you describe the bug, in approxim163        A good summary should quickly and uniquely identify a bug
>ately 60 or fewer characters? A good summary should quickly and u> report. Otherwise, developers cannot meaningfully query by bug s
>niquely identify a bug report. Otherwise, developers cannot meani>ummary, and will often fail to pay attention to your bug report w
>ngfully query by bug summary, and will often fail to pay attentio>hen reviewing a 10 page bug list. Think of it as a "title".
>n to your bug report when reviewing a 10 page bug list. Think of  
>it as a "title". 
130    </p>164      </dd>
131    <p>165      <dd>
132      A summary like "Drag-scrolling any web page crashes Mac OS 166        A summary like "Drag-scrolling any web page crashes Mac O
>X builds" is a useful title. "Crash" or "Drag Crash" would be exa>S X builds" is a useful title. "Crash" or "Drag Crash" would be e
>mples of a bad title.>xamples of a bad title.
167      </dd>
133    </p>168    </dl>
134    <p>169    <h3 name="Bug_description">
135      <b>Description:</b> What else can you tell the engineer abo170      Bug description
>ut this bug? Please provide as detailed of a problem diagnosis in 
> this field as possible, using the following example as a templat 
>e to go by: 
136    </p>171    </h3>
172    <dl>
173      <dt>
174        <span class="plain">Description:</span> What else can you
 > tell the engineer about this bug?
175      </dt>
176      <dd>
177        Please provide as detailed of a problem diagnosis in this
 > field as possible, using the following example as a template to 
 >go by:
178      </dd>
179    </dl>
t203      <h3 name="Original_Document_Information">t246      <h2 name="Original_document_information">
204        Original Document Information247        Original document information
205      </h3>248      </h2>

Back to History