Hi,
Just a minor comment on JIRA-generated release notes.
http://www.trex.informatik.uni-goettingen.de/jira/secure/ReleaseNote.jspa?pr...
If, as a user, I received this along with a new version of the tool, I would be unsure whether this first list was bugs that were fixed in this release or bugs that still remained in this release.
Bugs Fixed, Improvements and New Features would be better choices. I don't know if it is possible to change this in JIRA configs, but if not I would recommend manually changing them before using this information in a new release announcement.
Regards, Dominic
Dominic Evans wrote:
Hi,
Hi Dominic!
Just a minor comment on JIRA-generated release notes.
http://www.trex.informatik.uni-goettingen.de/jira/secure/ReleaseNote.jspa?pr...
Oh, it is possible to reference it directly?! That's convenient if we manage to apply the changes you suggest below.
If, as a user, I received this along with a new version of the tool, I would be unsure whether this first list was bugs that were fixed in this release or bugs that still remained in this release.
Bugs Fixed, Improvements and New Features would be better choices. I don't know if it is possible to change this in JIRA configs, but if not I would recommend manually changing them before using this information in a new release announcement.
You are definitely right! The easiest solution would be to fix it manually. But now as you demonstrated that it is possible to link to the created page, we should go for automation!
The solution is described on http://confluence.atlassian.com/display/JIRA/Tutorial+-+How+to+Create+a+Cust...
In the HTML template, we find:
#foreach ($issueType in $issueTypes) #if($issueType.issues.size() > 0) <h2>$textUtils.htmlEncode($issueType.name)</h2>
i.e. "Bug" is directly generated from the name of the issue type. Changing the name of the issue type "bug" to "bugs fixed" is no solution because when a user likes to file a new bug he had to choose then "bugs fixed" for a bug he is just reporting.
Hence, we should modify the release note template and use something like #if($issueType.name="Bug") <h2>Bugs fixed</h2> #else <h2>$textUtils.htmlEncode($issueType.name)</h2>
We can then also remove the "Edit/Copy Release Notes text area" to reduce confusion and link directly to the JIRA created file.
I will file this in JIRA as improvement to the Web Page component to be fixed for 0.5.2. (I made the experience that JIRA is really nice: I file a bug, and a few hours later JIRA reports that it's fixed. JIRA seems to be a really smart, because its able to fix bugs. ;-) But I have the impression that this service does not work always...)
Release 0.5.2 approaches in a pretty fast pace (even though we still "invent" new features to be included in 0.5.2). Very nice! I think we will have a really stable version for the tool demo at T3UC and SAM.
Best regards, Helmut
On Fri, May 19, 2006 at 03:04:00PM +0200, Helmut Neukirchen wrote:
Bugs Fixed, Improvements and New Features would be better choices. I don't know if it is possible to change this in JIRA configs, but if not I would recommend manually changing them before using this information in a new release announcement.
You are definitely right! The easiest solution would be to fix it manually. But now as you demonstrated that it is possible to link to the created page, we should go for automation!
The solution is described on http://confluence.atlassian.com/display/JIRA/Tutorial+-+How+to+Create+a+Cust...
<snip>> ... </snip>
Good work!
Release 0.5.2 approaches in a pretty fast pace (even though we still "invent" new features to be included in 0.5.2). Very nice! I think we will have a really stable version for the tool demo at T3UC and SAM.
Yes. I think 0.5.2 will be the milestone release that should attract more users to TRex.
Best regards, Dominic
Helmut Neukirchen wrote:
i.e. "Bug" is directly generated from the name of the issue type. Changing the name of the issue type "bug" to "bugs fixed" is no solution because when a user likes to file a new bug he had to choose then "bugs fixed" for a bug he is just reporting.
Hence, we should modify the release note template and use something like #if($issueType.name="Bug")
<h2>Bugs fixed</h2> #else <h2>$textUtils.htmlEncode($issueType.name)</h2>
How should the actual changes look in detail? My ideas:
"Bug" -> "Fixed Bugs" "Improvement" -> "Improvements" "New Feature" -> "New Features" "Task" -> ? How to treat tasks?
If we just use "Tasks" the user might think this is a task for him... (Well, maybe we should introduce tasks for our users, like "Send us chocolate!", "Contribute code!" ;-) )
How about "Performed Tasks"? Or should we simply not use this issue type?
Any ideas?
On Fri, May 19, 2006 at 04:40:03PM +0200, Helmut Neukirchen wrote:
How should the actual changes look in detail? My ideas:
"Bug" -> "Fixed Bugs" "Improvement" -> "Improvements" "New Feature" -> "New Features"
Yes these seem correct. I suppose you could maybe put the plural in brackets i.e. New Feature(s) as there may only be one but this isn't necessary.
"Task" -> ? How to treat tasks?
If we just use "Tasks" the user might think this is a task for him... (Well, maybe we should introduce tasks for our users, like "Send us chocolate!", "Contribute code!" ;-) )
How about "Performed Tasks"? Or should we simply not use this issue type?
Any ideas?
'Tasks Completed' maybe. But the only use I can think of for the 'Task' category are things like website maintenance or documentation writing. So these _probably_ aren't needed in release notes. Choose a name for now and just see what things fall into the Task category.
Regards, Dominic
http://www.trex.informatik.uni-goettingen.de/jira/secure/ReleaseNote.jspa?ve...
Call me "Velocity Guru"! Just kidding, that was really simply.
Hopefully, you did not work with JIRA, because I have to restart it to reread the new template. (Will modify the text output as well later, hence be prepared for further shutdowns.)
Bye, Helmut
On Fri, May 19, 2006 at 05:09:15PM +0200, Helmut Neukirchen wrote:
http://www.trex.informatik.uni-goettingen.de/jira/secure/ReleaseNote.jspa?ve...
Call me "Velocity Guru"! Just kidding, that was really simply.
:) Looks good!
Regards, Dominic
Helmut Neukirchen wrote:
http://www.trex.informatik.uni-goettingen.de/jira/secure/ReleaseNote.jspa?ve...
Call me "Velocity Guru"! Just kidding, that was really simply.
Hopefully, you did not work with JIRA, because I have to restart it to reread the new template. (Will modify the text output as well later, hence be prepared for further shutdowns.)
Comparing the created release notes and the road map view, I just realized the reason why by default the word "bug" is displayed: the release notes list also the UNRESOLVED issues. I think I will modify the template to display only the issues which are marked as RESOLVED (will investigate the life cycle of an issue whether any other status would be reasonable).
Bye, Helmut
Helmut Neukirchen wrote:
Helmut Neukirchen wrote:
http://www.trex.informatik.uni-goettingen.de/jira/secure/ReleaseNote.jspa?ve...
Call me "Velocity Guru"! Just kidding, that was really simply.
Hopefully, you did not work with JIRA, because I have to restart it to reread the new template. (Will modify the text output as well later, hence be prepared for further shutdowns.)
Comparing the created release notes and the road map view, I just realized the reason why by default the word "bug" is displayed: the release notes list also the UNRESOLVED issues. I think I will modify the template to display only the issues which are marked as RESOLVED (will investigate the life cycle of an issue whether any other status would be reasonable).
Fixed: We can now choose between JiraText/JiraHtml which is the orignal template and Text/Html which is my customised template which only display resolved issues, uses less confusing section names and knows when to use plural.
Currently, issues for all components are listed, i.e. also these for the web component.
Have a nice weekend, Helmut
trex-devel@informatik.uni-goettingen.de
-
Dominic Evans -
Helmut Neukirchen