Last Comment Bug 378590 - Update and shorten bug-writing guidelines
: Update and shorten bug-writing guidelines
Status: RESOLVED FIXED
:
Product: Bugzilla
Classification: Server Software
Component: Bugzilla-General (show other bugs)
: 2.20
: All All
: -- enhancement (vote)
: Bugzilla 3.0
Assigned To: Gervase Markham [:gerv]
: default-qa
Mentors:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2007-04-24 05:54 PDT by Gervase Markham [:gerv]
Modified: 2007-06-01 02:37 PDT (History)
2 users (show)
mkanat: approval+
mkanat: approval3.0+
See Also:
QA Whiteboard:
Iteration: ---
Points: ---


Attachments
New bug-writing.html.tmpl v.1 (5.77 KB, text/html)
2007-04-24 06:44 PDT, Gervase Markham [:gerv]
mkanat: review+
LpSolit: review+
Details
Patch v.1 (14.09 KB, patch)
2007-06-01 02:34 PDT, Gervase Markham [:gerv]
no flags Details | Diff | Review

Summon comment box

Description Gervase Markham [:gerv] 2007-04-24 05:54:34 PDT
The Mozilla project currently has two versions of the bug-writing guidelines:

The Bugzilla ones need to be updated to include the best of both - and, in my view, edited for brevity. This bug tracks that task. (The Mozilla ones will then need to be based on those, with a small set of necessary specialisations.)

Gerv
Comment 1 Gervase Markham [:gerv] 2007-04-24 06:44:55 PDT
Created attachment 262633 [details]
New bug-writing.html.tmpl v.1

Here's a possible new version. It is about 50% shorter but still, I assert, contains all the useful information from the previous version. And the shorter it is, the more likely people are to read it.

Gerv
Comment 2 Gervase Markham [:gerv] 2007-04-24 06:47:20 PDT
dbaron: I believe you had views on what this document should contain?

Gerv
Comment 3 Frédéric Buclin 2007-04-24 12:02:33 PDT
Comment on attachment 262633 [details]
New bug-writing.html.tmpl v.1

Looks good to me. r=LpSolit
Comment 4 Gervase Markham [:gerv] 2007-05-31 09:49:46 PDT
Max: do you want to review these, or is LpSolit's review good enough?

Also requesting approvals, including for the 3.0 branch, as it's only textual changes.

Gerv
Comment 5 Max Kanat-Alexander 2007-05-31 12:25:30 PDT
Comment on attachment 262633 [details]
New bug-writing.html.tmpl v.1

I'd like you also to mention that the summary should be a description of the problem, not a description of the reporter's suggested resolution.

Too many people file bugs like, "Firefox should do what I want," as opposed to "Firefox doesn't do X correctly."

Other than that this looks fine.
Comment 6 Max Kanat-Alexander 2007-05-31 12:27:37 PDT
This is essentially a docs change, so I see nothing wrong with it going into 3.0.

I would like to see an actual diff attached to this bug.
Comment 7 Gervase Markham [:gerv] 2007-06-01 02:34:56 PDT
Created attachment 266897 [details] [diff] [review]
Patch v.1

Patch, as requested - with a tweak as Max asked.

Gerv
Comment 8 Gervase Markham [:gerv] 2007-06-01 02:37:32 PDT
Trunk:

Checking in template/en/default/pages/bug-writing.html.tmpl;
/cvsroot/mozilla/webtools/bugzilla/template/en/default/pages/bug-writing.html.tmpl,v  <--  bug-writing.html.tmpl
new revision: 1.8; previous revision: 1.7
done

Bugzilla 3.0 branch:

Checking in template/en/default/pages/bug-writing.html.tmpl;
/cvsroot/mozilla/webtools/bugzilla/template/en/default/pages/bug-writing.html.tmpl,v  <--  bug-writing.html.tmpl
new revision: 1.6.2.2; previous revision: 1.6.2.1
done

Gerv

Note You need to log in before you can comment on or make changes to this bug.


Privacy Policy