Bug 420699 - Change default commit comment template
Summary: Change default commit comment template
Status: RESOLVED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: Mylyn (show other bugs)
Version: unspecified   Edit
Hardware: PC Linux
: P3 enhancement (vote)
Target Milestone: 3.11   Edit
Assignee: Leo Dos Santos CLA
QA Contact:
URL:
Whiteboard:
Keywords: contributed, noteworthy
Depends on:
Blocks:
 
Reported: 2013-10-30 03:50 EDT by Lars Vogel CLA
Modified: 2014-02-17 20:54 EST (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Lars Vogel CLA 2013-10-30 03:50:26 EDT
I suggest to remove the task status from the Mylyn commit message so that that get:

bug xxxxxxx - messages

instead of

New - bug xxxxxxx - messages

[Minor feature request: can you capitalize the b? -> Bug xxxxxxx - messages]
Comment 1 Markus Kuppe CLA 2013-10-30 03:51:28 EDT
The regular Team template is: 

${task.status} - ${connector.task.prefix} ${task.key}: ${task.description} 
${task.url}

Just deleting ${task.status} removes the status prefix.
Comment 2 Markus Kuppe CLA 2013-11-05 16:32:16 EST
http://waynebeaton.wordpress.com/2013/11/05/mylyn-egit-and-your-commit-message/ is a pretty good candidate for a new default.

[${task.key}] ${task.description} 

Bug: ${task.url}
Comment 3 Leo Dos Santos CLA 2014-02-12 19:46:49 EST
(In reply to comment #2)
> http://waynebeaton.wordpress.com/2013/11/05/mylyn-egit-and-your-commit-message/
> is a pretty good candidate for a new default.
> 
> [${task.key}] ${task.description}
> 
> Bug: ${task.url}

At Tasktop, many of us have standardized around a very similar template, replacing Bug: with Task-Url: as so:

${task.key}: ${task.description}

Task-Url: ${task.url}

Would this be an acceptable new default?
Comment 4 Markus Kuppe CLA 2014-02-13 02:00:46 EST
(In reply to Leo Dos Santos from comment #3)
> Task-Url: ${task.url}
> 
> Would this be an acceptable new default?

At eclipse.org the terminology has always been "bug" rather than "task".
Comment 5 Steffen Pingel CLA 2014-02-13 05:26:58 EST
+1 for the new template proposed in comment 3.
Comment 6 Tomasz Zarna CLA 2014-02-13 06:38:58 EST
"bug" is valid only for bugzilla, the new default should work for all possible connectors. That makes "task" a better replacement.

Would something like this work?

${task.key}: ${task.description}

${connector.task.prefix}-Url: ${task.url}
Comment 7 Steffen Pingel CLA 2014-02-13 09:55:15 EST
The task prefix isn't necessarily capitalized and connectors may set that to arbitrary values so I'd rather not put that into the template. I'm also not sure how well that works for repositories that have multiple task types such as Defects, Stories, Epics etc. I find "Task" a reasonably generic term that is suitable as a default. It's easy enough to customize the template for specific environments.
Comment 8 Wayne Beaton CLA 2014-02-13 10:25:06 EST
I agree that we have an investment in the word "Bug", but I agree that it's probably not appropriate. We misuse "Bug" to include lots of things that aren't bugs. I can't think of anything better than "Task", other than maybe "Ticket" or "Issue". I've never been particularly fond of "Ticket" either.

If we're going to go with "Task:" in the default template, we should consider changing the recommendation in the contribution guide.

https://wiki.eclipse.org/Development_Resources/Contributing_via_Git

Whatever we decide, any automated tools we build in the future to harvest this information are going to have to look for a lot of different patterns anyway, so adding one more isn't going to be a big deal...
Comment 9 Leo Dos Santos CLA 2014-02-13 13:54:40 EST
Each repository that Mylyn integrates with likes to use its own terminology to identify its issues (Issue, Bug, Defect, Ticket, etc.), and it doesn't make sense to favour one over the other. Over the last few years Mylyn has converged on the use of Task as a catch-all to refer to any issue type, so I think it makes sense to have that consistency in the commit template.
Comment 10 Leo Dos Santos CLA 2014-02-13 15:01:50 EST
For review: https://git.eclipse.org/r/#/c/21963/
Comment 11 Sam Davis CLA 2014-02-17 20:54:14 EST
The change was merged. The default commit template has been changed to 

bc.. ${task.key}: ${task.description} 

Task-Url: ${task.url}