2010-03-20 Maciej Stachowiak <mjs@apple.com>
[WebKit.git] / WebKitSite / quality / bugwriting.html
1 <?php
2     $title = "Bug Reporting Guidelines";
3     include("../header.inc");
4 ?>
5 <h2>Bug Reporting Guidelines</h2>
6
7 <p>This document describes how to write a good WebKit bug report. Good bug reports help developers and quality assurance (QA) people decide
8 an appropriate priority and severity for a bug, and increase the chance that a bug will be fixed quickly. The more specific information
9 you can provide, the better.</p>
10
11 <ol>
12     <li><b>Version</b>
13     <p>
14     Please select the WebKit version you were using when the bug occurred, or the closest matching version.
15     </p>
16     <p>
17     Versions of WebKit that are not part of a Safari release have a <code>+</code> after the version number, and their version number
18     is generally higher then the latest released version of WebKit. So, for example, <code>528+</code> is an unofficial build of WebKit
19     that is newer than the <code>525.x</code> version that shipped as part of Safari 3.1.2.
20     </p>
21     <div style="display: none; text-align: center; font-weight: bold;" id="webkit_version"></div>
22     <script type="text/javascript">
23         var regex = new RegExp("AppleWebKit/(.*?)( |$)");
24         var matches = regex.exec(navigator.userAgent);
25         if (matches)
26         {
27             var webKitVersion = document.getElementById('webkit_version');
28             webKitVersion.appendChild(document.createTextNode("You are currently using: "));
29             var versionNumber = document.createElement("tt");
30             versionNumber.appendChild(document.createTextNode(matches[1]));
31             webKitVersion.appendChild(versionNumber);
32             webKitVersion.style.display = "block";
33         }
34     </script>
35
36     <li><b>Component</b>
37         <p>If you know the precise cause of a bug (i.e., you've reduced it to a failing test case and know the reason), then you can
38         assign a bug to a specific component such as <code>CSS</code> or <code>HTML Editing</code>.
39         <p>If, however, there is any doubt in your mind as to the cause of the bug, then file it under <code>New Bugs</code>.  This component
40         is the place for any bugs whose cause has not yet been determined.  Once someone has reduced the bug and knows the cause, then it
41         will be moved from the <code>New Bugs</code> component to the appropriate place.</p>
42     </li>
43
44     <li>
45         <b>Platform and OS</b>
46         <p>Please select the platform and the OS version that your bug occurred on.  If you're running on Mac OS X this would often be platform
47         <code>Macintosh</code> and OS <code>Mac OS X 10.5</code> (Leopard).  If you're running on Windows or Linux, please select <code>PC</code> for platform
48         and the appropriate entry from the OS field.  If your exact system is not listed, please select the closest entry and provide further
49         details in the description of the bug report.
50     </li>
51
52     <li>
53         <b>Priority</b>
54         <p>Normally a QA person or developer will set this, so the bug submitter can leave this at the default value. A number of
55         <a href="bugpriorities.html">guidelines</a> and some individual judgment are involved in setting the priority. If you know the
56         bug is a regression, ie. something is wrong which wasn't wrong in previous versions of WebKit, you can set this to P1.</p>
57     </li>
58
59     <li>
60         <b>Severity</b>
61         <p>In most cases you should leave this at <code>normal</code>, but if you are confident that your bug is <code>trivial</code> or an
62         <code>enhancement</code>, it's helpful to specify that value. A QA person or developer will set this to some other value if
63         appropriate.</p>
64     </li>
65
66     <li><b>URL</b>
67         <p>Fill in this field with the URL of a page that shows the bug, when possible. If you have created a <a href="reduction.html">test case reduction</a> for the bug,
68         please add it to the bug report as an attachment rather than putting it on a web server and listing its URL here. Doing so
69         makes it easier to work on the bug, and can be a first step towards checking in the test case along with the bug fix.</p>
70     </li>
71
72     <li><b>Summary</b>
73     <p>A good summary explains the problem in clear and specific terms, but is often concise enough to fit within the default summary space in Bugzilla.
74         One should be able to tell exactly what a bug is about just by reading the summary.</p>
75
76     Tips for a good summary:
77     <ul>
78         <li>Include the domain of the page that shows the bug (especially if it's an important site)
79         <li>If the bug is a crash, note this and note whether or not the crash is reproducible
80         <li>If you have tested and verified that this is a regression from a previous version of WebKit, prepend "REGRESSION: " to the summary
81         <li>If you know the range of revisions in which the regression occurred, add this to the summary after REGRESSION (i.e., "REGRESSION(r31201-r31211):")
82     </ul><br>
83     </li>
84
85     <li><b>Description</b>
86     <p>In this field, write a more detailed explanation of the problem.</p>
87
88     Tips for Descriptions:
89     <ul>
90         <li>Do not include more than one bug in one bug report.</li>
91         <li>If you built WebKit yourself or used a nightly build, include the SVN revision number as well as information about if you are using WebKit with Qt, GTK+, wxWidgets, etc.</li>
92         <li>If loading a single URL is not enough to show the bug (for instance, you have to click through multiple pages for the bug to occur), then describe the exact navigation required to reach the page where the bug occurs. Don't just say "go to the forums"; use detailed steps.</li>
93         <li>Look at the system console and include any messages that might be relevant in the bug.</li>
94         <li>Include <a href="crashlogs.html">the backtrace</a> if you get a crash, if possible. File the bug first and then add the backtrace as an attachment.</li>
95         <li>Include a screenshot for visual bugs. If the problem isn't very obvious, include a single screenshot which shows both correct and incorrect renderings,
96             for example Safari and another browser such as Firefox or Internet Explorer.  On the Mac you can use Grab.app or Cmd-Shift-4 and capture a snap that demonstrates
97             the problem. You can then attach the screenshot to the bug.</li>
98         <li>Be as specific as possible. For instance, if you're describing a problem that occurs while scrolling, note in the bug whether you're scrolling with arrow
99             keys, arrow buttons, scroll thumb, clicking above or below the thumb, scroll-wheel mouse, etc.</li>
100     </ul><br></li>
101
102     <li><b>Keywords</b>
103         <p>If the bug is specific to one or more of the ports of WebKit (Qt, GTK, Wx, etc), please use any of the
104         <a href="https://bugs.webkit.org/describekeywords.cgi">valid keywords</a> to tag the bug report accordingly.</p>
105     </li>
106
107     <li>
108         <b>Depends on</b>
109         <p>If the fix for this bug depends on another bug fix, put the other bug's number here. Otherwise, leave it empty.</p>
110     </li>
111
112     <li>
113         <b>Blocks</b>
114         <p>If this bug blocks another bug from being fixed, put the other bug's number here. Otherwise, leave it empty.</p>
115     </li>
116 </ol>
117 <?php include("../footer.inc"); ?>