W3C home > Mailing lists > Public > www-webont-wg@w3.org > April 2002

RE: ISSUES - how to submit

From: Smith, Michael K <michael.smith@eds.com>
Date: Fri, 19 Apr 2002 09:38:06 -0500
Message-ID: <B8E84F4D9F65D411803500508BE322140D3F83CB@USPLM207>
To: Jeremy Carroll <jjc@hplb.hpl.hp.com>, www-webont-wg@w3.org
Here is what I sent to Jim yesterday as a format for raising and presenting
issues.  Basically I am trying to make my life simple.   

- Mike

Send issues in email tagged with 'ISSUE: <title>'
 
<title> should be short enough to be turned into a UID, but
descriptive enough for identification.  
 
Components of the message should follow the format below, using the
tags indicated.

FORMAT FOR ISSUE SUBMISSION
------------------------------------------------------------
Required:

TITLE: <title>

DESCRIPTION: One or two paragraphs.  Lengthy exposition should be
contained in the ATTACHMENT.  Or pointed to by a REFERENCE.

RAISED BY: Your name or the original source.


Optional:

STATUS: If you think it is something other than RAISED.  If you
identify it as CLOSED, include a RESOLUTION.

ATTACHMENT: Many of these issues will need extensive documentation
that could consume a lot of space.  The issues entry will link back to
this email msg.  Alternatively, if you think this issue has already
been explained in an existing message or set of messages, provide
pointers to them in REFERENCE. 
 
REFERENCE: URL(s) of other, relevant messages.

RESOLUTION: If you claim it is CLOSED, provide a short description
with a link to the minutes recording the decision.

TEST CASE: URL(s) for applicable test case.

You can string multiple issues in one email, as long as they begin
with TITLE.  But it will be clearer in the archive if they are
separate. 

------------------------------------------------------------
STATUS TAGS
 
 RAISED          : Submitted, but not currently being discussed.
 OPEN            : Actively being worked on.
 POSTPONED       : Activity suspended, perhaps until some other
                   controlling issue is resolved.  Do we need this,
                   or could we just revert to RAISED?
 CLOSED          : Resolved.
 SUBSUMED-BY uid : Allows some freedom in clearing up sets of issues.
 
------------------------------------------------------------
FORMAT OF ISSUE ENTRY
 
Components of issue documentation will include:
 
NAME        : Unique id derived from TITLE.  Thus,
              http://www.w3.org/2001/sw/WebOnt/webont-issues.html#<uid>
              will always provide a link to the issue.
TITLE       : Obvious
DESCRIPTION : One or two paragraphs.
RAISED BY   : Name, link to email
DATE        : Date raised.
STATUS      : [ RAISED | OPEN | POSTPONED | CLOSED | SUBSUMED-BY uid ]
RESOLUTION  : Short description with link to minutes recording decision
 
The following are optional.
 
TEST CASE   : Link to test case(s).
REFERENCE   : This field is present if there was elaboration beyond
              DESCRIPTION in the original email.
 
I would like to provide links to all of the relevant email discussion,
but I don't think that is practical.
Received on Friday, 19 April 2002 11:10:06 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Monday, 7 December 2009 10:57:49 GMT