geronimo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Matt Hogstrom <m...@hogstrom.org>
Subject Re: [DISCUSS] JIRA description text template for bug fixes
Date Sun, 16 Jul 2006 01:11:09 GMT
If you could provide an outline people can follow then that would be nice.  I expect not everyone

will do it but its a step forward.

Aaron Mulder wrote:
> The issue in question looks great, but I think asking everyone to use
> a specific format within their description is *way* too much to ask.
> If you want to propose some fields be added (such as symptom and so
> on) that would be better, but they'd have to have some descriptive
> text so people could tell what to put where.
> 
> Thanks,
>    Aaron
> 
> On 7/15/06, John Sisson <jrsisson@gmail.com> wrote:
>> What does everyone think of adopting a format similar to what I have
>> used in http://issues.apache.org/jira/browse/GERONIMO-2194 for JIRA
>> issues for "bug fixes".  I expect we would use a different format for
>> enhancements.  I got the idea from Derby's wiki  page
>> http://wiki.apache.org/db-derby/ReleaseNoteFormat .
>>
>> When a JIRA for a bug is closed, we should ensure it's description
>> generally follows that format.  When a new JIRA is created, it should be
>> just a matter of copying some template wiki markup into the issue.
>>
>> Following the format would have the following benefits:
>>
>> * Makes developers think about the information that other
>> users/developers would want to know about the problem
>> * Helps users who searching for problems reported with the release they
>> are running to get a better understanding of the issues with that
>> release and whether there are any workarounds to get them by until the
>> next release.
>>
>> If people are happy I'll add a wiki entry about the format.
>>
>> Regards,
>>
>> John
>>
> 
> 
> 

Mime
View raw message