Skip to content

bugzilla
bugzilla
Commit 8cf3b0b2 authored by gerv%gerv.net's avatar gerv%gerv.net
Browse files
Options

Bug 267671 - updates to the Bugzilla Helper to make it clearer and easier to…

Bug 267671 - updates to the Bugzilla Helper to make it clearer and easier to use, and to set expectations appropriately. Patch by gerv; r=myk, a=justdave.
parent 1e622db0
Show whitespace changes
Inline Side-by-side
Showing with 122 additions and 157 deletions
template/en/default/bug/create/create-guided.html.tmpl
View file @ 8cf3b0b2
...@@ -36,11 +36,13 @@ ...@@ -36,11 +36,13 @@
<p> <p>
<font color="red"> <font color="red">
This is a template used on mozilla.org - it, along with the This is a template used on mozilla.org. This template, and the
comment-guided.txt.tmpl template, are included as a demo of what it's comment-guided.txt.tmpl template that formats the data submitted via
the form in this template, are included as a demo of what it's
possible to do with custom templates in general, and custom [% terms.bug %] possible to do with custom templates in general, and custom [% terms.bug %]
entry templates in particular. You will need to alter the text of this entry templates in particular. As much of the text will not apply,
template if you want to use it on your [% terms.Bugzilla %] installation. you should alter it
if you want to use this form on your [% terms.Bugzilla %] installation.
</font> </font>
</p> </p>
...@@ -65,24 +67,7 @@ function PutDescription() { ...@@ -65,24 +67,7 @@ function PutDescription() {
} }
</script> </script>
[%# Browser sniff to try and reduce the incidence of 4.x and NS 6/7 bugs %] [%# Browser sniff to try and reduce the incidence of Netscape 6/7 bugs %]
[% IF cgi.user_agent("Mozilla/4") AND NOT cgi.user_agent("compatible") %]
<div style="background-color: lightgrey;
border: 1px solid black;
padding: 2px">
<font color="#990000">
<b>
Note: This is a tool for reporting [% terms.bugs %] in software from
mozilla.org. Use Netscape's
<a href="http://help.netscape.com/forms/bug-client.html">[% terms.bug %]
reporting form</a> to report [% terms.bugs %] with Netscape products
like Navigator 4.x. Netscape products have a blue and black N in the
top right hand corner.
</b>
</font>
</div>
[% END %]
[% IF cgi.user_agent('Netscape(\d)') %] [% IF cgi.user_agent('Netscape(\d)') %]
[% matches = cgi.user_agent().match('Netscape(\d)') %] [% matches = cgi.user_agent().match('Netscape(\d)') %]
...@@ -102,103 +87,84 @@ function PutDescription() { ...@@ -102,103 +87,84 @@ function PutDescription() {
in Netscape [% matches.0 %] with this form, you must reproduce it first in in Netscape [% matches.0 %] with this form, you must reproduce it first in
a recent build of a recent build of
<a href="http://ftp.mozilla.org/pub/mozilla.org/mozilla/nightly/latest/">Mozilla</a>, <a href="http://ftp.mozilla.org/pub/mozilla.org/mozilla/nightly/latest/">Mozilla</a>,
<a href="http://ftp.mozilla.org/pub/mozilla.org/firefox/nightly/latest-trunk/">Firefox</a> or <a href="http://ftp.mozilla.org/pub/mozilla.org/firefox/nightly/latest-trunk/">Firefox</a>,
<a href="http://ftp.mozilla.org/pub/mozilla.org/thunderbird/nightly/latest-trunk/">Thunderbird</a> or
<a href="http://ftp.mozilla.org/pub/mozilla.org/camino/nightly/latest/">Camino</a> <a href="http://ftp.mozilla.org/pub/mozilla.org/camino/nightly/latest/">Camino</a>
to make sure the problem hasn't been fixed already. to make sure the problem hasn't been fixed already.
</div> </div>
[% END %] [% END %]
<p> [% IF cgi.user_agent('Gecko/') %]
This form prompts you for the information required to [% matches = cgi.user_agent().match('Gecko/(\d+)') %]
file a good [% terms.bug %] report (or enhancement request.)
It may seem lengthy, but developers need all this information [% END %]
to understand and reproduce the [% terms.bug %], which is the first step towards
fixing it. Please note that <strong>we do not accept [% terms.bug %] reports by <!-- @@@ Need UA checking here -->
email</strong> - please do not email developers or mozilla.org staff
with [% terms.bug %] reports. <font color="red">Also, please do not
file [% terms.bugs %] on browser/email software older than two weeks - first,
download a newer build of
<a href="http://ftp.mozilla.org/pub/mozilla.org/mozilla/nightly/latest/">Mozilla</a>,
<a href="http://ftp.mozilla.org/pub/mozilla.org/firefox/nightly/latest-trunk/">Firefox</a>,
<a href="http://ftp.mozilla.org/pub/mozilla.org/camino/nightly/latest/">Camino</a>
or
<a href="http://ftp.mozilla.org/pub/mozilla.org/thunderbird/nightly/">Thunderbird</a>
and check that the problem is still present.
</font>
</p>
<a name="step1"></a> <a name="step1"></a>
<h3>Step 1 - search for your [% terms.bug %]</h3> <h3>Step 1 of 3 - has your [% terms.bug %] already been reported?</h3>
<p> <p>
Please see if your [% terms.bug %] has already been reported. <font color="red">Please don't skip this step - half of all bugs filed are
<font color="red">Please don't skip this step.</font> reported already.</font>
50% of the [% terms.bugs %] filed in Check the two lists of frequently-reported [% terms.bugs %]:
[%+ terms.Bugzilla %] are duplicates, and this wastes a lot of our QA engineers' time.
</p> </p>
[%# Stop NS 4.x and all v.3 browsers from getting <iframe> code %] [%# Include other products if sensible %]
[% IF (cgi.user_agent("Mozilla/4") [% IF product == "Firefox" %]
AND NOT cgi.user_agent("compatible")) [% productstring = "product=Mozilla%20Application%20Suite&amp;product=Firefox" %]
OR (cgi.user_agent("Mozilla/[123]")) %] [% ELSIF product == "Thunderbird" %]
<p> [% productstring = "product=Mozilla%20Application%20Suite&amp;product=Thunderbird" %]
Visit the <a href="duplicates.cgi">most-frequently-reported [% terms.bugs %] page</a>
and see if your [% terms.bug %] is there. If not, go to the
<a href="query.cgi?format=modern">search page</a>
and search [% terms.Bugzilla %] by entering two or
three of the main words having to do with your [% terms.bug %] in the top box.
For example: <tt><b>pop3 mail</b></tt> or <tt><b>copy paste</b></tt>.
</p>
[% ELSE %] [% ELSE %]
<p> [% productstring = "product=" _ product FILTER uri %]
Check the list of most-frequently-reported [% terms.bugs %] below. [% END %]
If your [% terms.bug %] isn't there, search [% terms.Bugzilla %] by entering two or
three of the main words having to do with your [% terms.bug %] in this box. <p>
<a href="duplicates.cgi?[% productstring %]&format=simple" target="somebugs">All-time Top 100</a> (loaded initially) |
<a href="duplicates.cgi?[% productstring %]&format=simple&sortby=delta&reverse=1&maxrows=100&changedsince=14" target="somebugs">Hot in the last two weeks</a>
</p>
<iframe name="somebugs" width="100%" height="80%"
style="border: 2px black solid"
src="duplicates.cgi?[% productstring %]&format=simple">
</iframe>
<p>
If your [% terms.bug %] isn't there, search [% terms.Bugzilla %] by entering
a few key words having to do with your [% terms.bug %] in this box.
For example: <tt><b>pop3 mail</b></tt> or <tt><b>copy paste</b></tt>. For example: <tt><b>pop3 mail</b></tt> or <tt><b>copy paste</b></tt>.
The results will appear above.
</p> </p>
[%# All bugs opened inside the past six months %]
<form action="buglist.cgi" method="get" target="somebugs"> <form action="buglist.cgi" method="get" target="somebugs">
<input type="hidden" name="format" value="simple"> <input type="hidden" name="format" value="simple">
<input type="hidden" name="order" value="relevance desc"> <input type="hidden" name="order" value="relevance desc">
<input type="hidden" name="bug_status" value="__open__"> <input type="hidden" name="bug_status" value="__all__">
<input type="hidden" name="product" value="[% product FILTER html %]"> <input type="hidden" name="product" value="[% product FILTER html %]">
<input type="hidden" name="chfieldfrom" value="-6m">
<input type="hidden" name="chfieldto" value="Now">
<input type="hidden" name="chfield" value="[Bug creation]">
<input type="text" name="content" size="40"> <input type="text" name="content" size="40">
<input type="submit" value="Search"> <input type="submit" value="Search">
</form> </form>
<iframe name="somebugs" width="100%" height="80%"
style="border: 2px black solid"
src="duplicates.cgi?product=[% product FILTER uri %]&format=simple">
</iframe>
[% END %]
<p> <p>
Look through the search results. If you get the Look through the search results. If you get the
<tt><b>Zarro Boogs</b></tt> message, [% terms.Bugzilla %] found no [% terms.bugs %] that <tt><b>Zarro Boogs</b></tt> message, [% terms.Bugzilla %] found no
match. Check for typos, or add fewer or different keywords. [% terms.bugs %] that
</p> match. Check for typing mistakes, or try fewer or different keywords.
If you find [% terms.abug %] that looks the same as yours, please add
<p> any useful extra information you have to it, rather than opening a new one.
If you find [% terms.abug %] that looks the same as yours, you can add
useful comments to that [% terms.bug %], but please don't open a new one.
Please don't add comments like "please fix this [% terms.bug %]" - this
tends to annoy engineers and slow, rather than speed, the fixing of it.
</p>
<p>
If you find [% terms.bugs %] similar to yours, read them and note which component
they are in. You should file your [% terms.bug %] in that same component.
</p> </p>
<a name="step2"></a> <a name="step2"></a>
<h3>Step 2 - give information</h3> <h3>Step 2 of 3 - give information</h3>
<p> <p>
If you're pretty certain that your [% terms.bug %] isn't in there already, then If you've tried a few searches and your [% terms.bug %] really isn't in
please try to complete this form as accurately as you there, tell us all about it.
can. The more you can tell us, the better our chance of being able
to understand and reproduce your [% terms.bug %].
</p> </p>
<form method="post" action="post_bug.cgi"> <form method="post" action="post_bug.cgi">
...@@ -212,7 +178,7 @@ function PutDescription() { ...@@ -212,7 +178,7 @@ function PutDescription() {
<table valign="top" cellpadding="5" cellspacing="5" border="0"> <table valign="top" cellpadding="5" cellspacing="5" border="0">
<tr bgcolor="[% tablecolour %]"> <tr bgcolor="[% tablecolour %]">
<td align="right" valign="middle"> <td align="right" valign="top">
<b>Product</b> <b>Product</b>
</td> </td>
<td valign="top"> <td valign="top">
...@@ -222,19 +188,10 @@ function PutDescription() { ...@@ -222,19 +188,10 @@ function PutDescription() {
</tr> </tr>
<tr> <tr>
<td align="right" valign="middle"> <td align="right" valign="top">
<b>Component</b> <b>Component</b>
</td> </td>
<td valign="top"> <td valign="top">
<p>
The area where the problem occurs.
To pick the right component, you could use the same one as
similar [% terms.bugs %] you found in your search, or read the full list of
<a href="describecomponents.cgi?product=
[% product FILTER url_quote %]">component
descriptions</a> if you need more help.
</p>
<table border="0" cellpadding="0" cellspacing="0"> <table border="0" cellpadding="0" cellspacing="0">
<tr> <tr>
<td valign="top"> <td valign="top">
...@@ -261,6 +218,15 @@ function PutDescription() { ...@@ -261,6 +218,15 @@ function PutDescription() {
</td> </td>
</tr> </tr>
</table> </table>
<p>
The area where the problem occurs.
To pick the right component, you could use the same one as
similar [% terms.bugs %] you found in your search, or read the full list of
<a target="_blank" href="describecomponents.cgi?product=
[% product FILTER url_quote %]">component
descriptions</a> (opens in new window) if you need more help.
</p>
</td> </td>
</tr> </tr>
...@@ -269,7 +235,7 @@ function PutDescription() { ...@@ -269,7 +235,7 @@ function PutDescription() {
[% rep_platform = [ "PC", "Macintosh", "All", "Other" ] %] [% rep_platform = [ "PC", "Macintosh", "All", "Other" ] %]
<tr bgcolor="[% tablecolour %]"> <tr bgcolor="[% tablecolour %]">
<td align="right" valign="middle"> <td align="right" valign="top">
<b>Hardware Platform</b> <b>Hardware Platform</b>
</td> </td>
<td valign="top"> <td valign="top">
...@@ -282,7 +248,7 @@ function PutDescription() { ...@@ -282,7 +248,7 @@ function PutDescription() {
"Linux", "All", "other" ] %] "Linux", "All", "other" ] %]
<tr> <tr>
<td align="right" valign="middle"> <td align="right" valign="top">
<b>Operating System</b> <b>Operating System</b>
</td> </td>
<td valign="top"> <td valign="top">
...@@ -294,46 +260,46 @@ function PutDescription() { ...@@ -294,46 +260,46 @@ function PutDescription() {
[% buildid = cgi.user_agent() IF matches %] [% buildid = cgi.user_agent() IF matches %]
<tr bgcolor="[% tablecolour %]"> <tr bgcolor="[% tablecolour %]">
<td align="right" valign="middle"> <td align="right" valign="top">
<b>Build Identifier<br>(User Agent)</b> <b>Build Identifier<br>(User Agent)</b>
</td> </td>
<td valign="top"> <td valign="top">
<input type="text" size="80" name="buildid" value="[% buildid %]">
<p> <p>
If reporting [% terms.abug %] in Mozilla, This identifies exactly the version of the product you were using.
If reporting [% terms.abug %] in Mozilla or Firefox,
this is the line beginning <tt>"Mozilla/5.0"</tt> in this is the line beginning <tt>"Mozilla/5.0"</tt> in
<tt>Help | About Mozilla</tt>. <tt>Help | About</tt>.
It identifies exactly the version of Mozilla you were using. If you are using the problematic software to file the bug, this
If you are using the problem copy of Mozilla, this will be field will already be filled in correctly.
filled in correctly for you already. If the product won't start, just enter the complete URL you
If Mozilla won't start, just enter the URL of the directory you
downloaded it from. downloaded it from.
</p> </p>
<input type="text" size="80" name="buildid" value="[% buildid %]">
</td> </td>
</tr> </tr>
<tr> <tr>
<td align="right" valign="middle"> <td align="right" valign="top">
<b>URL</b> <b>URL</b>
</td> </td>
<td valign="top"> <td valign="top">
<input type="text" size="80" name="bug_file_loc" value="http://">
<p> <p>
URL that demonstrates the problem you are seeing (optional.) URL that demonstrates the problem you are seeing (optional.)
<b>IMPORTANT</b>: If you are filing [% terms.abug %] about a broken web page, <!--
please read the <b>IMPORTANT</b>: problems with broken web pages go
<a href="http://www.mozilla.org/docs/web-developer/faq.html">Mozilla <a href="http://write-this-webtool/">in this form instead</a>.
Web Developer FAQ</a>, which explains how we handle old or -->
badly-coded web pages.
</p> </p>
<input type="text" size="80" name="bug_file_loc" value="http://">
</td> </td>
</tr> </tr>
<tr bgcolor="[% tablecolour %]"> <tr bgcolor="[% tablecolour %]">
<td align="right" valign="middle"> <td align="right" valign="top">
<b>Summary</b> <b>Summary</b>
</td> </td>
<td valign="top"> <td valign="top">
<input type="text" size="80" name="short_desc" id="short_desc">
<p> <p>
A sentence which summarises the problem. A sentence which summarises the problem.
Please be descriptive and use lots of keywords. Please be descriptive and use lots of keywords.
...@@ -348,51 +314,47 @@ function PutDescription() { ...@@ -348,51 +314,47 @@ function PutDescription() {
crash if I close the mail window while checking for new POP mail crash if I close the mail window while checking for new POP mail
</tt> </tt>
</p> </p>
<input type="text" size="80" name="short_desc" id="short_desc">
</td> </td>
</tr> </tr>
<tr> <tr>
<td align="right" valign="middle"> <td align="right" valign="top">
<b>Details</b> <b>Details</b>
</td> </td>
<td valign="top"> <td valign="top">
<textarea rows="6" cols="80" name="comment"
wrap="hard"></textarea>
<p> <p>
Expand on the Summary. Please be Expand on the Summary. Please be
as specific as possible about what is wrong. as specific as possible about what is wrong.
</p> </p>
<p> <p>
<tt> <tt>
<font color="#990000">Bad example</font>: This page looks wrong in <font color="#990000">Bad example</font>: Mozilla crashed.
Mozilla. Other browsers display it correctly. You suck! You suck!
</tt> </tt>
<br> <br>
<tt> <tt>
<font color="#009900">Good example</font>: In the <font color="#009900">Good example</font>: After a crash which
page at http://www.foo.com/, text in the first column should be happened when I was sorting in the Bookmark Manager,<br> all of my
fully justified -- text should be aligned with both the left and top-level bookmark folders beginning with the letters Q to Z are
right margins. In Mozilla, the text is only left-justified. no longer present.
</tt> </tt>
</p> </p>
<textarea rows="6" cols="80" name="comment"
wrap="hard"></textarea>
</td> </td>
</tr> </tr>
<tr bgcolor="[% tablecolour %]"> <tr bgcolor="[% tablecolour %]">
<td align="right" valign="middle"> <td align="right" valign="top">
<b>Reproducibility</b> <b>Reproducibility</b>
</td> </td>
<td valign="top"> <td valign="top">
<p>
How often can you reproduce the problem?
</p>
<select name="reproducible"> <select name="reproducible">
<option name="AlwaysReproducible" value="Always"> <option name="AlwaysReproducible" value="Always">
Every time. Happens every time.
</option> </option>
<option name="Sometimes" value="Sometimes"> <option name="Sometimes" value="Sometimes">
Sometimes, but not always. Happens sometimes, but not always.
</option> </option>
<option name="DidntTry" value="Didn't try"> <option name="DidntTry" value="Didn't try">
Haven't tried to reproduce it. Haven't tried to reproduce it.
...@@ -405,53 +367,55 @@ function PutDescription() { ...@@ -405,53 +367,55 @@ function PutDescription() {
</tr> </tr>
<tr> <tr>
<td align="right" valign="middle"> <td align="right" valign="top">
<b>Steps to Reproduce</b> <b>Steps to Reproduce</b>
</td> </td>
<td valign="top"> <td valign="top">
<p>
Describe how to reproduce the problem, step by
step. Include any special setup steps.
</p>
<textarea rows="4" cols="80" name="reproduce_steps" wrap="hard"> <textarea rows="4" cols="80" name="reproduce_steps" wrap="hard">
1. 1.
2. 2.
3. 3.
</textarea> </textarea>
<p>
Describe how to reproduce the problem, step by
step. Include any special setup steps.
</p>
</td> </td>
</tr> </tr>
<tr bgcolor="[% tablecolour %]"> <tr bgcolor="[% tablecolour %]">
<td valign="middle" align="right"> <td valign="top" align="right">
<b>Actual Results</b> <b>Actual Results</b>
</td> </td>
<td valign="top"> <td valign="top">
<textarea rows="4" cols="80" name="actual_results"
wrap="hard"></textarea>
<p> <p>
What happened after you performed the steps above? What happened after you performed the steps above?
</p> </p>
<textarea rows="4" cols="80" name="actual_results"
wrap="hard"></textarea>
</td> </td>
</tr> </tr>
<tr> <tr>
<td valign="middle" align="right"> <td valign="top" align="right">
<b>Expected Results</b> <b>Expected Results</b>
</td> </td>
<td valign="top"> <td valign="top">
<textarea rows="4" cols="80" name="expected_results"
wrap="hard"></textarea>
<p> <p>
What should the software have done instead? What should the software have done instead?
</p> </p>
<textarea rows="4" cols="80" name="expected_results"
wrap="hard"></textarea>
</td> </td>
</tr> </tr>
<tr bgcolor="[% tablecolour %]"> <tr bgcolor="[% tablecolour %]">
<td valign="middle" align="right"> <td valign="top" align="right">
<b>Additional Information</b> <b>Additional Information</b>
</td> </td>
<td valign="top"> <td valign="top">
<textarea rows="8" cols="80" name="additional_info"
wrap="hard"></textarea>
<p> <p>
Add any additional information you feel may be Add any additional information you feel may be
relevant to this [% terms.bug %], such as the <b>theme</b> you were relevant to this [% terms.bug %], such as the <b>theme</b> you were
...@@ -470,25 +434,15 @@ function PutDescription() { ...@@ -470,25 +434,15 @@ function PutDescription() {
which the software crashed (e.g., <tt>Application Violation in which the software crashed (e.g., <tt>Application Violation in
gkhtml.dll</tt>). gkhtml.dll</tt>).
</p> </p>
<textarea rows="8" cols="80" name="additional_info"
wrap="hard"></textarea>
</td> </td>
</tr> </tr>
<tr> <tr>
<td valign="middle" align="right"> <td valign="top" align="right">
<b>Severity</b> <b>Severity</b>
</td> </td>
<td valign="top"> <td valign="top">
<p>
How serious the problem is. Also, if your [% terms.bug %] is a request for a new
feature or enhancement, say so here.
</p>
<select name="bug_severity"> <select name="bug_severity">
<option name="blocker" value="blocker">
Blocker: This [% terms.bug %] prevents Mozilla developers from
testing or developing the software.
</option>
<option name="critical" value="critical"> <option name="critical" value="critical">
Critical: The software crashes, hangs, or causes you to Critical: The software crashes, hangs, or causes you to
lose data. lose data.
...@@ -510,13 +464,17 @@ function PutDescription() { ...@@ -510,13 +464,17 @@ function PutDescription() {
Enhancement: Request for new feature or enhancement. Enhancement: Request for new feature or enhancement.
</option> </option>
</select> </select>
<p>
Say how serious the problem is, or if your [% terms.bug %] is a
request for a new feature.
</p>
</td> </td>
</tr> </tr>
</table> </table>
<a name="step3"></a> <a name="step3"></a>
<h3>Step 3 - submit the [% terms.bug %]</h3> <h3>Step 3 of 3 - submit the [% terms.bug %] report</h3>
<p> <p>
<input type="submit" value=" Submit [% terms.Bug %] Report " <input type="submit" value=" Submit [% terms.Bug %] Report "
...@@ -529,6 +487,13 @@ function PutDescription() { ...@@ -529,6 +487,13 @@ function PutDescription() {
<p> <p>
That's it! Thanks very much. You'll be notified by email about any That's it! Thanks very much. You'll be notified by email about any
progress that is made on fixing your [% terms.bug %]. progress that is made on fixing your [% terms.bug %].
<p>
Please be warned
that we get a lot of bug reports filed - it may take quite a while to
get around to yours. You can help the process by making sure your bug is
complete and easy to understand, and by quickly replying to any questions
which may arrive by email.
</p> </p>
</form> </form>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment