[IGSTK-Developers] Requirement section headings in bug tracker

[David Gobbi]

Hi All,

Picking up where we left off on the idea of requirement section headings 
and the bugtracker:

The headings entries in the bug tracker could be formatted nearly the 
same as the requirements themselves, but with the last digits missing:

REQ 06
Tracker Requirements

REQ 06.01
Tracker Functional Requirements

The point brought up by Luis is that we need to enforce that people 
don't commit code using a heading number instead of a full requirement 
number. 

I think this is already enforced, because Andy's scripts refuses to 
accept commits unless the CVS log follow the following pattern:

ENH: [description of change] REQUIREMENT: REQ ##.##.##.

Any attempt to commits code to a requirement of the form "REQ ##.##" or 
"REQ ##" will be refused, just as it should be.

So are we okay to add the section headings to the bugtracker?

 - David

Luis Ibanez wrote:

>
> David,
>
> Yeap, that was an experiment that we did after a tcon brainstorming
> with Brian, Andy and Kevin G. It actually mapped the hierarchy that
> Brian had created originally in his requirements Word document. At
> the time we were checking if the requirements will appear in the correct
> order when sorting them by "Title".
>
> I agree with you that it is worth revisiting for having sections and
> subsections in the requirements hierarchy.
>
> It may not be too bad that those high level requirements don't match
> the format expected by the checking script, because it is unlikely
> that we commit code based only on a top level requirement. However,
> I guess that we can ask Andy to extend the script in order to accept
> the following formats too:
>
>       REQ ##
>       REQ ##.##
>       REQ ##.##.##
>
>
> Still...
> somehow I would prefer that commits are associated to the most
> specific requirement possible, instead of something as general
> as "REQ: 06  = Tracker Functional Requirement".
>
>
>
>    Luis
>
>
>
> -------------------
> David Gobbi wrote:
>
>> Here is a very interesting entry from a year ago that I found in the 
>> bug tracker:
>>
>> ID: 1106
>> Title: 06.01.00 Tracker Functional Requirements
>> Description: Attempt to build a hierarchy.
>>
>> This was an attempt by someone (Luis?) to put requirement section 
>> headings into the bug tracker.  I think it is a great idea and 
>> definitely worth revisiting.
>>
>> The headings entries in the bug tracker could be formatted nearly the 
>> same as the requirements themselves, but with the last digits missing:
>>
>> REQ 06
>> Tracker Requirements
>>
>> REQ 06.01
>> Tracker Functional Requirements
>>
>> Because of the missing digits, the heading entries don't fit the 
>> pattern "REQ ##.##.##" and people would not be able to do CVS commits 
>> against them.  But it would still be easy for the document-generating 
>> script to find them and pull them out.
>>
>> Any thoughts?
>>
>>  - David
>> _______________________________________________
>> IGSTK-Developers mailing list
>> IGSTK-Developers at public.kitware.com
>> http://public.kitware.com/cgi-bin/mailman/listinfo/igstk-developers
>>
>>
>
>