From 8cf3b0b2556edb2b7e7c77d65c681be3fbede7d9 Mon Sep 17 00:00:00 2001 From: "gerv%gerv.net" <> Date: Sat, 1 Jan 2005 20:50:46 +0000 Subject: 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. --- .../en/default/bug/create/create-guided.html.tmpl | 281 +++++++++------------ 1 file changed, 123 insertions(+), 158 deletions(-) (limited to 'template') diff --git a/template/en/default/bug/create/create-guided.html.tmpl b/template/en/default/bug/create/create-guided.html.tmpl index f7affee10..87f7a668f 100644 --- a/template/en/default/bug/create/create-guided.html.tmpl +++ b/template/en/default/bug/create/create-guided.html.tmpl @@ -36,11 +36,13 @@

- This is a template used on mozilla.org - it, along with the - comment-guided.txt.tmpl template, are included as a demo of what it's + This is a template used on mozilla.org. This template, and the + 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 %] - entry templates in particular. You will need to alter the text of this - template if you want to use it on your [% terms.Bugzilla %] installation. + entry templates in particular. As much of the text will not apply, + you should alter it + if you want to use this form on your [% terms.Bugzilla %] installation.

@@ -65,24 +67,7 @@ function PutDescription() { } -[%# Browser sniff to try and reduce the incidence of 4.x and NS 6/7 bugs %] - -[% IF cgi.user_agent("Mozilla/4") AND NOT cgi.user_agent("compatible") %] -
- - - Note: This is a tool for reporting [% terms.bugs %] in software from - mozilla.org. Use Netscape's - [% terms.bug %] - reporting form 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. - - -
-[% END %] +[%# Browser sniff to try and reduce the incidence of Netscape 6/7 bugs %] [% IF cgi.user_agent('Netscape(\d)') %] [% matches = cgi.user_agent().match('Netscape(\d)') %] @@ -102,103 +87,84 @@ function PutDescription() { in Netscape [% matches.0 %] with this form, you must reproduce it first in a recent build of Mozilla, - Firefox or + Firefox, +Thunderbird or Camino to make sure the problem hasn't been fixed already. [% END %] -

- This form prompts you for the information required to - file a good [% terms.bug %] report (or enhancement request.) - It may seem lengthy, but developers need all this information - to understand and reproduce the [% terms.bug %], which is the first step towards - fixing it. Please note that we do not accept [% terms.bug %] reports by - email - please do not email developers or mozilla.org staff - with [% terms.bug %] reports. Also, please do not - file [% terms.bugs %] on browser/email software older than two weeks - first, - download a newer build of - Mozilla, - Firefox, - Camino - or - Thunderbird - and check that the problem is still present. - -

+[% IF cgi.user_agent('Gecko/') %] + [% matches = cgi.user_agent().match('Gecko/(\d+)') %] + +[% END %] + + -

Step 1 - search for your [% terms.bug %]

+

Step 1 of 3 - has your [% terms.bug %] already been reported?

- Please see if your [% terms.bug %] has already been reported. - Please don't skip this step. - 50% of the [% terms.bugs %] filed in - [%+ terms.Bugzilla %] are duplicates, and this wastes a lot of our QA engineers' time. + Please don't skip this step - half of all bugs filed are + reported already. + Check the two lists of frequently-reported [% terms.bugs %]:

-[%# Stop NS 4.x and all v.3 browsers from getting + +

+ 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: pop3 mail or copy paste. + The results will appear above.

+[%# All bugs opened inside the past six months %]
- + + + +
- -[% END %] -

Look through the search results. If you get the - Zarro Boogs message, [% terms.Bugzilla %] found no [% terms.bugs %] that - match. Check for typos, or add fewer or different keywords. -

- -

- 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. -

- -

- 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. + Zarro Boogs message, [% terms.Bugzilla %] found no + [% terms.bugs %] that + match. Check for typing mistakes, or try fewer or different keywords. + If you find [% terms.abug %] that looks the same as yours, please add + any useful extra information you have to it, rather than opening a new one.

-

Step 2 - give information

+

Step 2 of 3 - give information

- If you're pretty certain that your [% terms.bug %] isn't in there already, then - please try to complete this form as accurately as you - can. The more you can tell us, the better our chance of being able - to understand and reproduce your [% terms.bug %]. + If you've tried a few searches and your [% terms.bug %] really isn't in + there, tell us all about it.

@@ -212,7 +178,7 @@ function PutDescription() { - - @@ -269,7 +235,7 @@ function PutDescription() { [% rep_platform = [ "PC", "Macintosh", "All", "Other" ] %] - - - - - - - - - - - -
+ Product @@ -222,19 +188,10 @@ function PutDescription() {
+ Component -

- 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 - component - descriptions if you need more help. -

-
@@ -261,6 +218,15 @@ function PutDescription() {
+ +

+ 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 + component + descriptions (opens in new window) if you need more help. +

+ Hardware Platform @@ -282,7 +248,7 @@ function PutDescription() { "Linux", "All", "other" ] %]
+ Operating System @@ -294,46 +260,46 @@ function PutDescription() { [% buildid = cgi.user_agent() IF matches %]
+ Build Identifier
(User Agent) 		+

- 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 "Mozilla/5.0" in - Help | About Mozilla. - It identifies exactly the version of Mozilla you were using. - If you are using the problem copy of Mozilla, this will be - filled in correctly for you already. - If Mozilla won't start, just enter the URL of the directory you + Help | About. + If you are using the problematic software to file the bug, this + field will already be filled in correctly. + If the product won't start, just enter the complete URL you downloaded it from.

-
+ URL +

URL that demonstrates the problem you are seeing (optional.) - IMPORTANT: If you are filing [% terms.abug %] about a broken web page, - please read the - Mozilla - Web Developer FAQ, which explains how we handle old or - badly-coded web pages. +

-
+ Summary +

A sentence which summarises the problem. Please be descriptive and use lots of keywords. @@ -348,51 +314,47 @@ function PutDescription() { crash if I close the mail window while checking for new POP mail

-
+ Details +

Expand on the Summary. Please be as specific as possible about what is wrong.

- Bad example: This page looks wrong in - Mozilla. Other browsers display it correctly. You suck! + Bad example: Mozilla crashed. + You suck!
- Good example: In the - page at http://www.foo.com/, text in the first column should be - fully justified -- text should be aligned with both the left and - right margins. In Mozilla, the text is only left-justified. + Good example: After a crash which + happened when I was sorting in the Bookmark Manager,
all of my + top-level bookmark folders beginning with the letters Q to Z are + no longer present.

-
+ Reproducibility -

- How often can you reproduce the problem? -

+ Steps to Reproduce -

- Describe how to reproduce the problem, step by - step. Include any special setup steps. -

+

+ Describe how to reproduce the problem, step by + step. Include any special setup steps. +

+ Actual Results +

What happened after you performed the steps above?

-
+ Expected Results +

What should the software have done instead?

-
+ Additional Information +

Add any additional information you feel may be relevant to this [% terms.bug %], such as the theme you were @@ -470,25 +434,15 @@ function PutDescription() { which the software crashed (e.g., Application Violation in gkhtml.dll).

-
+ Severity -

- How serious the problem is. Also, if your [% terms.bug %] is a request for a new - feature or enhancement, say so here. -

+

+ Say how serious the problem is, or if your [% terms.bug %] is a + request for a new feature. +

-

Step 3 - submit the [% terms.bug %]

+

Step 3 of 3 - submit the [% terms.bug %] report

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 %]. + +

+ 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.

-- cgit v1.2.3-24-g4f1b