Compare Revisions

Bug writing guidelines

Revision 12890:

Revision 12890 by Nickolay on

Revision 12891:

Revision 12891 by Tygerstar35 on

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

Revision 12890
Revision 12891
t27    <h2 name="How_to_write_a_useful_bug_report">t
28      How to write a useful bug report
29    </h2>
30    <p>
31      Useful bug reports are ones that get bugs fixed. A useful b
>ug report normally has two qualities: 
32    </p>27    <p>
33    <ol>28      When I attempt to open a MS Word attachment in my Earthlink
 > account AND I'm using a Mozilla browser, the document no longer 
 >is formatted in Word, and opens with "application/octet-stream". 
 >If I save this document on my desktop, it format is "File", not M
 >S Word [though it opens and reads through MS Word. Some friends h
 >ave reported they cannot open MS Word attachments I've been sendi
 >ng them {{mediawiki.external('via Mozilla')}} -- the prefix "null
 >_" is added to the title of the document.
34      <li>
35        <b>Reproducible.</b> If an engineer can't see the problem
> or conclusively prove that it exists, the engineer will probably 
> stamp it <tt>WORKSFORME</tt> or <tt>INVALID</tt>, and move on to 
> the next bug. Every relevant detail you can provide helps. 
36      </li>
37      <li>
38        <b>Specific.</b> The quicker the engineer can isolate the
> issue to a specific problem, the more likely it'll be expedientl 
>y fixed. If you're crashing on a site, please take the time to is 
>olate what on the page is triggering the crash, and include it as 
> an HTML snippet in the bug report if possible. (Specific bugs ha 
>ve the added bonus of remaining relevant when an engineer actuall 
>y gets to them; in a rapidly changing web, a bug report of "foo.c 
>om crashes my browser" becomes meaningless after the site experie 
>nces a half-dozen redesigns and hundreds of content changes.) 
39      </li>
40    </ol>
41    <div class="highlight">
42      <p>
43        Let's say you crash at foo.com, and want to write up a bu
>g report: 
44      </p>
45      <p>
46        <b>BAD</b>: "My browser crashed. I think I was on foo.com
>. I think that this is a really bad problem and you should fix it 
> or else nobody will use your browser. By the way, my sister thin 
>ks your icons really suck. Oh, and my mom's home page doesn't loo 
>k right, either, it's all messed up. Thx 4 fixing theze bugz." 
47      </p>
48      <p>
49        <b>GOOD</b>: "I crashed each time when I went to foo.com,
> using Mozilla on a Win NT 4.0 (Service Pack 5) system. The build 
> ID is 20030609. I also rebooted into Linux, and reproduced this  
>problem using the 20030608 Linux build. Mozilla crashed each time 
> upon drawing the Foo banner at the top of the page. I broke apar 
>t the page, and discovered that the following image link will cra 
>sh Mozilla reproducibly, unless you remove the "border=0" attribu 
>te: 
50      </p>
51      <p>
52        <code><span class="plain">&lt;IMG SRC="http://foo.com/ima
>ges/topics/topicfoos.gif" width=34 height=44 border=0 alt="News"& 
>gt;</span></code> 
53      </p>
54    </div>
55    <p>29    </p>
56      If your problem is Mozilla crashing, Talkback data is very 
>helpful to engineers trying to diagnose the problem. If you can c 
>onsistently reproduce the crash, please download a build with Tal 
>kback (also known as Quality Feedback Agent, or QFA) and install  
>it. Then, do what is necessary to reproduce the crash, and follow 
> the instructions for sending crash data to the server. Lastly, r 
>un the program <tt>components/talkback.exe</tt> (Win32) or <tt>co 
>mponents/talkback/talkback</tt> (Unix) and find your "Incident ID 
>". Include this with the bug report. Please don't paste the raw T 
>alkback data into your bug. See <a class="external" href="http:// 
>kb.mozillazine.org/Quality_Feedback_Agent">Quality Feedback Agent 
> page on MozillaZine</a> for more information about Talkback. 
57    </p>30    <p>
31      If I access my Earthlink account through MS IE, the Word at
 >tachment opens and save without a problem. If I access my Hotmail
 > account through Mozilla, the Word attachment opens and save with
 >out a problem.
58    <p>32    </p>
59      We'd also recommend reviewing a few of the better bug repor
>ts, such as {{template.Bug(2683)}}, {{template.Bug(3092)}}, or {{ 
>template.Bug(4044)}}. Bug submissions that do not meet these "Use 
>ful Bug Report" criteria tend to be investigated on a time-availa 
>ble basis, if they're investigated at all. 
60    </p>33    <p>
34      There appears to be a problem with the formatting of attach
 >ments when Mozilla and Earthlink are combined. I contacted Earthl
 >ink last night and they could not remedy the problem. They sugges
 >ted I contact you and inform you of this problem.
61    <p>35    </p>
62      Lastly, Simon Tatham has written an excellent document, <a 36    <p>
>class="external" href="http://www.chiark.greenend.org.uk/~sgtatha 
>m/bugs.html">How to Report Bugs Effectively</a>, which has more e 
>xcellent advice on good bug reporting. 
37      If you are able to replicate and remedy this, please contac
 >t me at omegatouch@earthlink.net
38    </p>
39    <p>
40      Thanks -- Linda

Back to History