Fixes by Mark Rowe and Joost de Valk. Reviewed by Darin. Landed by ap.
[WebKit-https.git] / WebKitSite / quality / reporting.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
2 <html>
3 <head>
4   <meta content="text/html; charset=ISO-8859-1"
5  http-equiv="content-type">
6   <title>Reporting Bugs</title>
7   <link rel=stylesheet href="../webkitdev.css">
8   <script type="text/javascript">
9         /* 
10         Copyright (C) 2006 Joost de Valk, http://www.joostdevalk.nl/.  All rights reserved.
11         Copyright (C) 2006 Mark Rowe, http://bdash.net.nz/.  All rights reserved.
12         Copyright (C) 2006 Apple Computer, Inc.  All rights reserved.
13         
14         Redistribution and use in source and binary forms, with or without
15         modification, are permitted provided that the following conditions
16         are met:
17         1. Redistributions of source code must retain the above copyright
18            notice, this list of conditions and the following disclaimer.
19         2. Redistributions in binary form must reproduce the above copyright
20            notice, this list of conditions and the following disclaimer in the
21            documentation and/or other materials provided with the distribution.
22         
23         THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
24         EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25         IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26         PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
27         CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
28         EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
29         PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30         PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
31         OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32         (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33         OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34         
35         Script used for recognizing Safari / WebKit. A matrix of these versions can
36         be found at: http://developer.apple.com/internet/safari/uamatrix.html .
37         */
38         function parse_version(version)
39         {
40                 var bits = version.split(".");
41                 var is_nightly = (version[version.length - 1] == "+");
42                 return {major: parseInt(bits[0]), minor: parseInt(bits[1]), is_nightly: is_nightly};
43         }
44         
45         function display(id, display_style)
46         {
47                 document.getElementById(id).style.display = display_style;
48         }
49         
50         function get_version()
51         {
52                 var regex = new RegExp("Mozilla/5.0 \\(.*\\) AppleWebKit/(.*) \\(KHTML, like Gecko\\) Safari/(.*)");
53                 var matches = regex.exec(navigator.userAgent);
54                 if (! matches)
55                         return;
56
57                 // We have detected a safari version, hide the unknown version text
58                 display('unknown_version', 'none');
59                 var webkit_version = parse_version(matches[1]);
60                 var safari_version = parse_version(matches[2]);
61
62
63                 if (safari_version.major < 100)
64                         // Mac OS X 10.2
65                         display('10point2', 'block');
66
67
68                 else if (safari_version.major >= 100 && safari_version.major < 400)
69                 {
70                         // Mac OS X 10.3
71                         display('10point3', 'block');
72
73                         if (safari_version.major < 312)
74                                 // Mac OS X 10.3.8 or lower
75                                 display('updateto10_3_9', 'block');
76
77                         else if (safari_version.minor < 5)
78                                 // Mac OS X 10.3.9 but not the latest Safari update
79                                 display('update10_3_9_safari', 'block');
80
81                         else
82                                 // Mac OS X 10.3.9 with the latest Safari update
83                                 display('best10_3_9_safari', 'block');
84
85
86                 } else {
87                         // Mac OS X 10.4
88                         display('10point4', 'block');
89
90                         if (webkit_version.major == 412 && webkit_version.is_nightly)
91                                 // Using an old nightly
92                                 display('neednewnightly', 'block');
93
94                         else if (webkit_version.major == 420 && webkit_version.is_nightly)
95                                 // Using a recent nightly, not sure which
96                                 display('mightneednewnightly', 'block');
97
98                         else if (safari_version.major < 417)
99                                 // 10.4.3 or lower
100                                 display('updateto10_4_4', 'block');
101
102                         else
103                                 // 10.4.4
104                                 display('10_4_4', 'block');
105                 } 
106         }
107 </script>
108 </head>
109 <body>
110 <!--begin sidebar -->
111 <iframe id="sidebar" src="../sidebar.html"></iframe>
112 <!--end sidebar -->
113
114 <div id="banner">
115 Reporting Bugs
116 </div>
117
118 <div id="content">
119 <h3>You have found a bug? Here are 5 steps to getting it fixed!</h3>
120 <ol>
121 <li>
122 <strong>Check your WebKit version</strong><br>
123 <div id="unknown_version">
124         To make sure you're not wasting your (and our) time, you should be using the latest version of WebKit before you file your bug.
125         You should run at least Mac OS X 10.3.9 before filing bugs. Your WebKit version should be 312 or higher if you are on 
126         Panther and 417 or higher if you are on Tiger. If you're running
127         Mac OS X 10.4, you could also <a href="http://nightly.webkit.org">download the latest nightly</a> build to be sure you
128         have the latest version. If you've done this and you still experience the bug, go ahead to the next step.
129 </div>
130 <div id="10point2" style="display: none;">
131         We're sorry, we do not accept bugreports anymore from people using OS X 10.2. To many bugs have been fixed since then. We advise
132         you to upgrade to OS X 10.4.
133 </div>
134 <div id="10point3" style="display: none;">
135         <div id="updateto10_3_9" style="display: none;">
136                 You are using Mac OS X 10.3.8 or lower, please before filing any bugs, upgrade to Mac OS X 10.3.9.
137         </div>
138         <div id="update10_3_9_safari" style="display: none;">
139                 You are using Mac OS X 10.3.9, but your Safari isn't the latest version. Please, before filing any bugs, upgrade your Safari.
140         </div>
141         <div id="best10_3_9_safari">
142                 You are using Mac OS X 10.3.9, and the latest version of Safari, go ahead and file your bug!
143         </div>
144 </div>
145 <div id="10point4" style="display: none;">
146         <div id="neednewnightly" style="display: none;">
147                 You are already using a nightly build, which is very good! A large number of bugs has been fixed since you downloaded
148                 this nightly build though, so please <a href="http://nightly.webkit.org/">get the latest nightly</a>.
149         </div>
150         <div id="mightneednewnightly" style="display: none;">
151                 You are already using a nightly build, which is very good! Unfortunately, we can't detect when you downloaded it, but
152                 if that was more then a few days ago, please <a href="http://nightly.webkit.org/">get the latest nightly</a>.
153         </div>
154         <div id="updateto10_4_4" style="display: none;">
155                 You are using Mac OS X 10.4.3 or lower, please before filing any bugs, do either of the following:
156                 <ul>
157                         <li>Upgrade to Mac OS X 10.4.4, or:</li>
158                         <li><a href="http://nightly.webkit.org">Download the latest nightly</a>.</li>
159                 </ul>
160         </div>
161         <div id="10_4_4" style="display: none;">
162                 You are using Mac OS X 10.4.4, go ahead and file your bug, or if you want to <a href="http://nightly.webkit.org">
163                 download the latest nightly</a> and see if your bug is already fixed.
164         </div>
165 </div>
166 <script type="text/javascript">get_version();</script>
167 </li>
168 <li>
169 <strong>Search Bugzilla</strong><br>
170 Now that you have the latest WebKit version and still think you've found a WebKit bug, 
171 <a href="http://bugzilla.opendarwin.org/query.cgi?format=specific&amp;product=WebKit">search through Bugzilla</a> first
172 to see if anyone else has already filed it. This step is very important! If you find that someone has filed your bug
173 already, please go to the next step anyway, but instead of filing a new bug, comment on the one you've found. If you can't
174 find your bug in Bugzilla, go to the next step.
175 </li>
176 <li>
177 <strong>Create a Bugzilla account</strong><br>
178 You will need to <a href="http://bugzilla.opendarwin.org/createaccount.cgi">sign up for a Bugzilla account</a> to be able
179 to report bugs (and to comment on them). Once you have an account you can report bugs on any product on 
180 <a href="http://www.opendarwin.org">OpenDarwin.org</a>. WebKit is one of the individual products listed in Bugzilla, and all 
181 of our bugs can be classified in various components under the WebKit product. If you have registered, proceed to the
182 next step.
183 </li>
184 <li>
185 <strong>File the bug!</strong><br>
186 Now you are ready to <a href="http://webkit.org/new-bug">file a bug on the WebKit product</a>. The <a href="bugwriting.html">
187 Writing a Good Bug Report</a> document (also linked in the sidebar) gives some tips about the most useful information to include
188 in bug reports. The better your bug report, the higher the chance that your bug will be addressed (and possibly fixed) 
189 quickly!
190 </li>
191 <li>
192 <strong>What happens next?</strong><br>
193 Once your bug is filed, you will receive email when it is updated at each stage in the <a href="lifecycle.html">bug life cycle</a>.
194 After the bug is considered fixed, you may be asked to download the <a href="http://nightly.webkit.org">latest nightly</a> 
195 and confirm that the fix works for you.
196 </li>
197 </ol>
198 <p>
199 <strong>Note:</strong> <br>
200 To report bugs in Safari, or WebKit bugs that may contain confidential information, please use
201 <a href="http://bugreporter.apple.com">http://bugreporter.apple.com/</a>.
202 </p>
203 </div>
204
205 </body>
206 </html>