Re: Two forked copies of bug writing guidelines

Gervase Markham <[email protected]> Mon, 12 Mar 2007 11:46:39 +0000
Newsgroups gmane.comp.mozilla.documentation
Message-ID <[email protected]>
L. David Baron wrote:
> I just discovered we have two copies of the bug writing guidelines:
> 
> https://bugzilla.mozilla.org/page.cgi?id=bug-writing.html

I believe that this copy exists because it can be given Bugzilla branding.

> http://developer.mozilla.org/en/docs/Bug_writing_guidelines

This copy exists because it was moved from here:
http://www.mozilla.org/quality/bug-writing-guidelines.html
I think it was moved a while back, but only saw significant editing 
recently.

> and different people have been making improvements on each copy.  We
> should probably try to merge these improvements (and make more).

Indeed. DRY.

We should also try and make it shorter, perhaps separating out rationale 
into a separate document or a set of hidden <p>s with "Why?" links. If 
we encourage all bug filers to read this, it needs to be snappy and to 
the point.

> Where *should* the bug writing guidelines live?  (And how would one
> edit the copy on bugzilla.mozilla.org if that's the chosen
> location?)

To edit the copy on bugzilla.mozilla.org, you need to get the current 
version, write a new copy, and persuade a Bugzilla admin to put it in 
place. If this is supposed to be a living document, that's not really an 
optimal procedure. So I suggest deprecating the b.m.o. version.

If people agree, I will file a bug on making the b.m.o. changes, and 
work on producing a version in the wiki which contains the best of both.

Gerv