NormalizedBugFormat

Differences between revisions 3 and 4
Revision 3 as of 2008-07-10 12:10:25
Size: 1593
Editor: e177174028
Comment:
Revision 4 as of 2008-07-10 12:13:26
Size: 1604
Editor: e177174028
Comment:
Deletions are marked like this. Additions are marked like this.
Line 44: Line 44:
Type: <null-deref|random-memory|double-free|...> Type (optional): <null-deref|random-memory|double-free|...>

The MozillaTeam has certain requirements that bug summary/description have to fulfill before qualifying for status confirmed.

For now we have normalized formats for feature bugs and crash bugs:

Feature Bugs

Summary

The summary gives a comprehensible line describing the bug.

Description Template

Summary: <REPEAT the Bug Summary here>

Steps to reproduce:
  1. step 1
  2. step 2
  3.

Expected Result:
 <what do you expect to happen after following the steps above>

Actual Result:
 <what happens instead>

References:
 1. launchpad URL to file 1 / <one line about the attachment 1>
 2. ...

The References section must contain all attachments used in the "Steps to reproduce", "Expected Result" or "Actual Result" paragraphs.

Crash Bugs

Summary

  • The summary must not contain general wordings like "firefox crashes out of nowhere"; these kind of statements tend to pull in false-duplicate comments
  • The summary must read "<APPLICATION> crash in @TopmostFunctionSignature", e.g. "firefox crash in @nsDocLoader::ReadAll"

Description Template

Summary: <REPEAT the Bug Summary here>

Type (optional): <null-deref|random-memory|double-free|...>

Backtrace: <launchpad URL to best backtrace available>

Steps to reproduce crash (optional):
  1. step 1
  2. step 2
  3.

References:
 1. launchpad URL to file 1 / <one line about the attachment 1>
 2. ...

The References section must contain all attachments used in the "Steps to reproduce crash" paragraph.

MozillaTeam/NormalizedBugFormat (last edited 2008-08-06 17:01:19 by localhost)