mozilla

Compare Revisions

Bug writing guidelines

Change Revisions

Revision 12935:

Revision 12935 by Jesse on

Revision 12936:

Revision 12936 by zhangxwhome on

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

Revision 12935
Revision 12936
n7    <div class="note">n
8      <p>
9        <strong>If you need help with Mozilla software (for examp
>le with Firefox or Thunderbird), use one of the available <a clas 
>s="external" href="http://www.mozilla.org/support/">support optio 
>ns</a>. Do not edit this page.</strong> 
10      </p>
11      <p>
12        If you're new to reporting bugs, you may want to try gett
>ing help from the more experienced contributors. See the Communit 
>y section on the <a href="/en/QA" title="en/QA">QA</a> page for p 
>ointers. If you're going to report a Firefox bug, you can also ge 
>t assistance in the <span style="font-family: monospace;">#firefo 
>x</span> channel on <a class="external" href="http://irc.mozilla. 
>org/" title="http://irc.mozilla.org/">irc.mozilla.org</a>. 
13      </p>
14    </div>
t16      Effective bug reports are the most likely to be fixed. Thest8      AdapterDeviceID: 0x2e22<br>
>e guidelines explain how to write such reports. 
17    </p>9      AdapterVendorID: 0x8086<br>
18    <h2>10      Add-ons: <a class=" link-mailto" href="mailto:firebug@softw
 >are.joehewitt.com:1" rel="freelink">firebug@software.joehewitt.co
 >m:1</a>.8.4,<a class=" link-mailto" href="mailto:sroussey@illumin
 >ation-for-developers.com:1" rel="freelink">sroussey@illumination-
 >for-developers.com:1</a>.1.10,{972ce4c6-7e08-4474-a285-3208198ce6
 >fd}:11.0a1<br>
19      Preliminaries11      AvailableVirtualMemory: 8795535335424<br>
20    </h2>12      BuildID: 20111219031209<br>
21    <ol>13      CrashTime: 1324459160<br>
22      <li>Make sure your software is up to date.14      EMCheckCompatibility: true<br>
23        <ul>15      Email: <a class=" link-mailto" href="mailto:zhangxwhome@163
 >.com" rel="freelink">zhangxwhome@163.com</a><br>
24          <li>Ideally, test an in-development version to see whet16      FramePoisonBase: 7ffffffff0de0000<br>
>her your bug has already been fixed (e.g. <a class=" external" hr 
>ef="http://www.mozilla.com/en-US/firefox/channel/" title="http:// 
>www.mozilla.com/en-US/firefox/channel/">Firefox Beta, Aurora</a>, 
> or bleeding-edge <a class=" link-https" href="https://nightly.mo 
>zilla.org/" title="https://nightly.mozilla.org/">Nightly</a>). 
25          </li>17      FramePoisonSize: 65536<br>
26        </ul>18      InstallTime: 1324459141<br>
27      </li>19      Notes: AdapterVendorID: 0x8086, AdapterDeviceID: 0x2e22, Ad
 >apterSubsysID: 50028086, AdapterDriverVersion: 8.15.10.2302<br>
28      <li>Search <a class="link-https" href="https://bugzilla.moz20      D2D? D2D+<br>
>illa.org/">Bugzilla</a> to see whether your bug has already been  
>reported (<a class="external" href="http://www.mozilla.org/qualit 
>y/help/screening-duplicates.html">tutorial</a>). 
29      </li>21      DWrite? DWrite+<br>
30      <li>Open the <a class="link-https" href="https://bugzilla.m22      D3D10 Layers? D3D10 Layers+<br>
>ozilla.org/enter_bug.cgi?format=guided">Enter a new bug</a> form, 
> which will guide you through most of the bug reporting process.< 
>br> 
31        <ul>
32          <li>If you have multiple issues, please file separate b
>ug reports. 
33          </li>
34        </ul>
35      </li>
36    </ol>
37    <h2>
38      Writing precise steps to reproduce
39    </h2>
40    <p>
41      How can a developer reproduce the bug on his or her own com
>puter? 
42    </p>
43    <p>
44      Steps to reproduce are the <strong>most important part of a
>ny bug report</strong>. If a developer is able to reproduce the b 
>ug, the bug is very likely to be fixed. If the steps are unclear, 
> it might not even be possible to know whether the bug has been f 
>ixed. 
45    </p>
46    <p>
47      Describe your method of interacting with Firefox in additio
>n to the intent of each step. 
48    </p>
49    <ul>
50      <li>Imprecise:&nbsp;"Open Gmail in another window".
51      </li>
52      <li>Precise:&nbsp;"Press Cmd+N to open a new browser window
>, then type <a class=" link-https" href="https://mail.google.com/ 
>" rel="freelink">https://mail.google.com/</a> in the address bar  
>and press Enter". 
53      </li>
54    </ul>
55    <p>
56      After your steps, precisely describe the observed result an
>d the expected result. Clearly separate facts (observations) from 
> speculations. 
57    </p>
58    <ul>
59      <li>Imprecise:&nbsp;"It doesn't work"
60      </li>
61      <li>23      <br>
62        <p>24      ProductID: {ec8030f7-c20a-464f-9b0e-13a3a9e97384}<br>
63          Precise:&nbsp;"Instead of showing my Inbox, it shows th25      ProductName: Firefox<br>
>e message 'Your browser does not support cookies (error -91)'." 
64        </p>26      ReleaseChannel: nightly<br>
65      </li>27      SecondsSinceLastCrash: 146267<br>
66    </ul>28      StartupTime: 1324459141<br>
67    <p>29      SystemMemoryUsePercentage: 87<br>
68      If the bug seems egregious, there might be something unusua30      Theme: classic/1.0<br>
>l about your setup that's a necessary part of the steps to reprod 
>uce the bug. See if you can reproduce the bug in a <a class=" ext 
>ernal" href="http://support.mozilla.com/en-US/kb/Managing-profile 
>s" title="http://support.mozilla.com/en-US/kb/Managing-profiles"> 
>new Firefox profile</a>. If the bug only happens in your existing 
> profile, try to figure out what settings, extensions, or <a clas 
>s=" external" href="http://support.mozilla.com/en-US/kb/Profiles" 
> title="http://support.mozilla.com/en-US/kb/Profiles">files in yo 
>ur profile</a> are needed to reproduce the bug. 
69    </p>31      Throttleable: 1<br>
70    <ul>32      TotalVirtualMemory: 8796092891136<br>
33      URL: <a class=" external" href="file:///C:/Users/zhangxuewe
 >n/Desktop/test/test/FormXLSTerviceHandler.axd%20-%20Copy.xml" rel
 >="freelink">file:///C:/Users/zhangxuewen/Desktop...20-%20Copy.xml
 ></a><br>
34      Vendor: Mozilla<br>
35      Version: 11.0a1<br>
36      Winsock_LSP: MSAFD Tcpip [TCP/IP] : 2 : 1 : &nbsp;<br>
37      &nbsp;MSAFD Tcpip [UDP/IP] : 2 : 2 : %SystemRoot%\system32\
 >mswsock.dll<br>
38      &nbsp;MSAFD Tcpip [RAW/IP] : 2 : 3 : &nbsp;<br>
39      &nbsp;MSAFD Tcpip [TCP/IPv6] : 2 : 1 : %SystemRoot%\system3
 >2\mswsock.dll<br>
40      &nbsp;MSAFD Tcpip [UDP/IPv6] : 2 : 2 : &nbsp;<br>
41      &nbsp;MSAFD Tcpip [RAW/IPv6] : 2 : 3 : %SystemRoot%\system3
 >2\mswsock.dll<br>
42      &nbsp;RSVP TCPv6 Service Provider : 2 : 1 : &nbsp;<br>
43      &nbsp;RSVP TCP Service Provider : 2 : 1 : %SystemRoot%\syst
 >em32\mswsock.dll<br>
44      &nbsp;RSVP UDPv6 Service Provider : 2 : 2 : &nbsp;<br>
45      &nbsp;RSVP UDP Service Provider : 2 : 2 : %SystemRoot%\syst
 >em32\mswsock.dll<br>
71      <li>46      <br>
72        <a class=" external" href="http://www.chiark.greenend.org47      This report also contains technical information about the s
>.uk/~sgtatham/bugs.html#intermittent" title="http://www.chiark.gr>tate of the application when it crashed.
>eenend.org.uk/~sgtatham/bugs.html#intermittent">What if my bug se 
>ems "random"&nbsp;or "intermittent"?</a> 
73      </li>
74    </ul>
75    <h2>
76      <strong>Writing a clear summary</strong>
77    </h2>
78    <p>
79      How would you describe the bug using approximately 10 words
>? This is the first part of your bug report a triager or develope 
>r will see. 
80    </p>
81    <p>
82      A good summary should quickly and uniquely identify a bug r
>eport. It should explain the problem, not your suggested solution 
>. 
83    </p>
84    <ul>
85      <li>Good: "Cancelling a File Copy dialog crashes File Manag
>er" 
86      </li>
87      <li>Bad: "Software crashes"
88      </li>
89    </ul>
90    <ul>
91      <li>Good:&nbsp;"Down-arrow scrolling doesn't work in &lt;te
>xtarea&gt; styled with overflow:hidden" 
92      </li>
93      <li>Bad: "Browser should work with my web site"
94      </li>
95    </ul>
96    <h2>
97      <span style="font-weight: bold;">Finding the correct produc
>t and component</span> 
98    </h2>
99    <p>
100      You will be asked to categorize your bug into a "product" a
>nd a "component" within that product, in order to direct your rep 
>ort to the correct developers. 
101    </p>
102    <p>
103      If you're using Firefox, the bug is most likely in "Firefox
>", "Toolkit", or "Core". 
104    </p>
105    <ul>
106      <li>
107        <a class=" link-https" href="https://bugzilla.mozilla.org
>/describecomponents.cgi?product=Firefox" title="https://bugzilla. 
>mozilla.org/describecomponents.cgi?product=Firefox">List of compo 
>nents in the "Firefox" product</a> - Most parts of Firefox that y 
>ou interact with directly 
108      </li>
109      <li>
110        <a class=" link-https" href="https://bugzilla.mozilla.org
>/describecomponents.cgi?product=Toolkit" title="https://bugzilla. 
>mozilla.org/describecomponents.cgi?product=Toolkit">List of compo 
>nents in the "Toolkit"&nbsp;product</a> - Interface widgets and s 
>ome frontend features 
111      </li>
112      <li>
113        <a class=" link-https" href="https://bugzilla.mozilla.org
>/describecomponents.cgi?product=Core" title="https://bugzilla.moz 
>illa.org/describecomponents.cgi?product=Core">List of components  
>in the "Core"&nbsp;product</a> - Web page rendering, networking,  
>etc. 
114      </li>
115    </ul>
116    <p>
117      When in doubt, search for similar bugs and see what compone
>nt they are in. 
118    </p>
119    <p>
120      If none of the components seem appropriate, look for a "Gen
>eral" component in the most appropriate product. 
121    </p>
122    <h2>
123      Specific types of bugs
124    </h2>
125    <p>
126      If you are reporting a <strong>crash bug</strong>, please <
>a href="/En/How_to_get_a_stacktrace_for_a_bug_report" title="http 
>s://developer.mozilla.org/En/How_to_get_a_stacktrace_for_a_bug_re 
>port">include a Breakpad ID&nbsp;or attach stack trace</a>, and i 
>nclude the crash signature in the bug summary. 
127    </p>
128    <p>
129      If you are reporting a <strong>memory use or leak bug</stro
>ng>, please attach the output of about:memory (Firefox 6+). Ideal 
>ly, find steps to reproduce an increase in what is shown in about 
>:memory (even after clicking the "Minimize memory usage"&nbsp;but 
>ton at the bottom). If you have trouble finding steps to reproduc 
>e, try the Firefox Support page titled <a class=" external" href= 
>"http://support.mozilla.com/en-US/kb/High%20memory%20usage" title 
>="http://support.mozilla.com/en-US/kb/High memory usage">High Mem 
>ory Usage</a>. If you are a C++&nbsp;developer, <a class=" link-h 
>ttps" href="https://wiki.mozilla.org/Performance:Leak_Tools" titl 
>e="https://wiki.mozilla.org/Performance:Leak_Tools">more precise  
>tools are available</a>. 
130    </p>
131    <p>
132      If you are reporting a <strong>bug involving a specific web
> page</strong>, please try to make a <a href="/en/Reducing_testca 
>ses" title="https://developer.mozilla.org/en/Reducing_testcases"> 
>reduced testcase</a> and attach it to the bug report. 
133    </p>
134    <p>
135      If the bug was <strong>recently introduced</strong>, findin
>g a <a class=" external" href="http://quality.mozilla.org/docs/bu 
>gzilla/guide-to-triaging-bugs-for-firefox/finding-a-regression-wi 
>ndow/" title="http://quality.mozilla.org/docs/bugzilla/guide-to-t 
>riaging-bugs-for-firefox/finding-a-regression-window/">regression 
> window</a> can help identify the cause of the bug. 
136    </p>
137    <div class="originaldocinfo">
138      <h2>
139        Original document information
140      </h2>
141      <ul>
142        <li>Author(s): Jesse Ruderman, Gervase Markham
143        </li>
144        <li>Other Contributors: Eli Goldberg, Claudius Gayle, Jan
> Leger, Felix Miata, Peter Mock, Chris Pratt, Chris Yeh,&nbsp;and 
> others. 
145        </li>
146      </ul>
147    </div>
148    <p>
149      {{ languages( { "de": "de/Richtlinien_zum_Schreiben_eines_B
>ugreports", "fr": "fr/Recommandations_pour_l\'\u00e9criture_d\'un 
>_bug", "ja": "ja/Bug_writing_guidelines" } ) }} 

Back to History