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

Reply via email to