Update and shorten bug-writing guidelines

RESOLVED FIXED in Bugzilla 3.0

Status

()

Bugzilla
Bugzilla-General
--
enhancement
RESOLVED FIXED
11 years ago
10 years ago

People

(Reporter: gerv, Assigned: gerv)

Tracking

2.20
Bugzilla 3.0
Bug Flags:
approval +
approval3.0 +

Details

Attachments

(2 attachments)

(Assignee)

Description

11 years ago
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
(Assignee)

Comment 1

11 years ago
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
Attachment #262633 - Flags: review?(mkanat)
(Assignee)

Updated

11 years ago
Attachment #262633 - Attachment mime type: application/octet-stream → text/html
(Assignee)

Comment 2

11 years ago
dbaron: I believe you had views on what this document should contain?

Gerv

Comment 3

11 years ago
Comment on attachment 262633 [details]
New bug-writing.html.tmpl v.1

Looks good to me. r=LpSolit
Attachment #262633 - Flags: review+
(Assignee)

Comment 4

10 years ago
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
Status: NEW → ASSIGNED
Flags: approval?
Flags: approval3.0?

Comment 5

10 years ago
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.
Attachment #262633 - Flags: review?(mkanat) → review+

Comment 6

10 years ago
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.
Flags: approval?
Flags: approval3.0?
Flags: approval3.0+
Flags: approval+
Target Milestone: --- → Bugzilla 3.0
(Assignee)

Comment 7

10 years ago
Created attachment 266897 [details] [diff] [review]
Patch v.1

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

Gerv
(Assignee)

Comment 8

10 years ago
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
Status: ASSIGNED → RESOLVED
Last Resolved: 10 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.