More Bug Stuff

[Evan Prodromou]

OK, so, here's my collected bug file headers list. It gives the header
name, arity (can be 0, 1, or Inf), and a description of what it's
for. Let me know if I'm missing anything here.

* Number (1)

  Identifying number for the bug, as an integer. Ex:

  Number: 12

* Title (1)

  Short descriptive title for the bug. Ex:

  Title: documentation mistakenly defines :autoload argument as expr and not 
list

* Reported-By (0,1)

  Name and email address of person who reported the bug, in
  angle-bracket format. Ex:

  Reported-By: Evan Prodromou <address@hidden>

* Date-Reported (0,1)

  Date the bug was reported. Ex:

  Date-Reported: Sun, 24 Mar 2002 11:31:17 -0800
  Date-Reported: 24 Mar 2002

  All dates must either be in the above "standard" format, or in the
  format:

            dd Mon YYYY

* Status (1)

  Status of the bug, in the format:

         status-val [(comment)]

  Here, status-val is one of: New, Unassigned, Assigned, Closed,
  Suspended, and comment is an optional comment. 

  Status: New (received from address@hidden)
  Status: Suspended (unable to replicate error)
  Status: Closed

* Priority (0,Inf)

  Priority of the bug, in this format:

           priority-val [[version=[version no]] (comment)]

  where priority-val is an integer between 1 and 10, and lower
  numbers are higher priority. The version number is the Guile branch
  or version where this is supposed to be fixed. For example, if a bug
  is of high priority to fix in 1.6, but not so high for 1.4, then the
  Priority headers would be:

  Priority: 8 version=1.4 (not severe enough to warrant work)
  Priority: 2 version=1.6 (crucial for release; talk to rlb)

  Priorities should be unique for a version.

* Severity (0,1)

  How severe the bug is, in terms of what it does to the user. Field
  is:

        severity-val [(comment)]

  Where severity-val is one of:
  
        Wibni (meaning "Wouldn't it be nice if...")

        Theoretical (such as "Buffer overflow possible in guile-readline to
                     get root")

        Nuisance (such as "There's no documentation on this function, so I
                  had to experiment with it")

        Minor (such as "It doesn't work as advertised")
        
        Major (such as "It does damage")
        
        Fatal (such as "Guile killed my dog")

  ...and comment is an optional comment.

  For example:

  Severity: Nuisance (misspelling)
  Severity: Major (Memory leak)
  Severity: Minor
  Severity: Fatal (dumps core)

  NOTE that Priority and Severity are loosely coupled -- things that
  are more severe usually will have a high priority, but not
  necessarily. For example, updating the version string for a release
  is a high priority task, but it's not particularly severe (it'd be a
  nuisance). A bug that randomly causes backup tape explosions in the
  TI-99/4 port of Guile might have high severity, but a low priority.

* Affects-Version (0,Inf)

  Versions of Guile affected by the bug.

  Affects-Version: 1.4
  Affects-Version: 1.6.1
  Affects-Version: 1.7

* Assigned-To (0,1)

  Name and email address of the person this bug is assigned to. Ex:

  Assigned-To: Marius Vollmer <address@hidden>

* Date-Fixed (0,Inf)

  Date the bug was fixed, in format:

       date-string version=vno

  Can be multiple if fixed in different branches. vno is the release
  version number that the fixed version should be available. 

  Example:

  Date-Fixed: Sun, 24 Mar 2002 11:31:17 -0800 version=1.5.7
  Date-Fixed: 05 Dec 1999 version=1.7.1
  Date-Fixed: 12 Apr 2001 version=1.4.1

~ESP

-- 
Evan Prodromou
address@hidden