[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
RE: [platform-ui-dev] Commit comment format for reporting of bugs
|
I agree. We've been having some talks
around this as part of Aaron's re-work of the releng 'release' tool.Specifically
the comment needs to be able to capture interim work for a defect (i.e.
you're part-way to having a defect fixed but it's not yet done...). Here,
there is -no- change in the defect state but you can still reference the
defect (which should contain any extra info related to the particular checkin...).
I'm not really sure what we get from
having the actual URL though rather than just using hte Bugzilla 'defect
<nnnnn>' format. Within the workbench we should be able to handle
this with tooling (i.e. a 'Show defect' menu item on the elements in the
History View...). Outside the workbench I find it simple enough to just
paste the defect # into Bigzilla/Google directly.
My 2 cents,
Eric
Michael Valenta/Ottawa/IBM@IBMCA
Sent by: platform-ui-dev-bounces@xxxxxxxxxxx
09/12/2006 09:17 AM
Please respond to
"Eclipse Platform UI component developers list." <platform-ui-dev@xxxxxxxxxxx> |
|
To
| "Eclipse Platform UI component
developers list." <platform-ui-dev@xxxxxxxxxxx>
|
cc
|
|
Subject
| RE: [platform-ui-dev] Commit comment
format for reporting of bugs |
|
IMHO, including the status in the commit comment problematic since
the status can change (i.e. a bug can be reopened) and the commit comment
cannot. Or, to put it another way, the commit comment is not a good place
to try and track the lifecycle of a bug. The best place for this is the
bug report itself. Therefore, I also am in favour of the format Tod suggested.
Michael
Daniel Megert <daniel_megert@xxxxxxxxxx>
Sent by: platform-ui-dev-bounces@xxxxxxxxxxx
09/12/2006 03:25 AM
Please respond to
"Eclipse Platform UI component developers list." <platform-ui-dev@xxxxxxxxxxx> |
|
To
| "Eclipse Platform UI
component developers list." <platform-ui-dev@xxxxxxxxxxx>
|
cc
|
|
Subject
| RE: [platform-ui-dev] Commit comment
format for reporting of bugs |
|
Unless there's better tool support to produce the commit text (e.g. allow
code assist and template variables in the commit dialog) I am against a
too
rigid/complicated format especially if it is combined with rules like
"every committer must follow that format". For now I like the
simple
solution suggested by Tod.
I prefer FIXED over RESOLVED since besides RESOLVED FIXED there is also
RESOLVED INVALID, RESOLVED WONTFIX, etc.
Dani
"Mik Kersten"
<beatmik@xxxxxxx>
Sent by:
To
platform-ui-dev-b
"'Eclipse Platform UI component
ounces@xxxxxxxxxx
developers list.'"
g
<platform-ui-dev@xxxxxxxxxxx>
cc
"'Mylar
developer discussions'"
12.09.2006 03:28
<mylar-dev@xxxxxxxxxxx>
Subject
RE: [platform-ui-dev]
Commit
Please respond to
comment format for reporting of
"Eclipse Platform
bugs
UI component
developers list."
<platform-ui-dev@
eclipse.org>
Mylar automatically generates similar commit comments. I'm wondering
if we
could come up with a standard format recommended across eclipse.org
projects. On the Mylar project have been using a similar format for
about
a
year and are about to improve it as a result of our upcoming commit comment
templates (see attached screenshot, note that UI will be simplified). Here
is what we're thinking of for the default format:
${task.status}: {task.id}\n${task.url}
E.g.
RESOLVED: 138666: [EditorMgmt] provide mechanism for restoring editors
https://bugs.eclipse.org/bugs/show_bug.cgi?id=138666
This is too much to format by hand (e.g. the URL, which is useful for web
based tools such as Fisheye). But it would be good for us to 'compatible'
with a manual format like the one proposed below. However "Fix
for" reads
awkwardly for enhancements. So I wonder if you could consider making
the
manual format something like the following, and then we could encourage
other Eclipse.org projects to adopt this approach and make it the basis
of
the default template for Mylar.
RESOLVED: bug 123: description
The status prefix could be optional, but can be convenient as discussed
on:
117517: add support for commit comment templates
https://bugs.eclipse.org/bugs/show_bug.cgi?id=117517#28
Mik
> -----Original Message-----
> From: platform-ui-dev-bounces@xxxxxxxxxxx [mailto:platform-ui-dev-
> bounces@xxxxxxxxxxx] On Behalf Of Tod Creasey
> Sent: Wednesday, August 09, 2006 12:25 PM
> To: platform-ui-dev@xxxxxxxxxxx
> Subject: [platform-ui-dev] Commit comment format for reporting of
bugs
>
> As many of you have noticed the Platform UI team has been generating
the
> list of fixed bugs each build and posting a message to this list after
we
> submit the map file. This list is generated using the soon to be released
> "Generate Build Notes" option in the releng tool.
>
> Any revision with a comment of the form Fix for Bug 12345 xxxx
description
> will be used to generate this list which we hope will be a lot of
help to
> the members of the community who wish to track our work. Please
be sure
> to use this format to ensure your fixes get reported. The easiest
way to
> get this format is to copy the top line of Bugzilla report and to
paste
it
> into the commit dialog.
>
> Tod
> _______________________________________________
> platform-ui-dev mailing list
> platform-ui-dev@xxxxxxxxxxx
> https://dev.eclipse.org/mailman/listinfo/platform-ui-dev
(See attached file: commit-templates.gif)
_______________________________________________
platform-ui-dev mailing list
platform-ui-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/platform-ui-dev
_______________________________________________
platform-ui-dev mailing list
platform-ui-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/platform-ui-dev
_______________________________________________
platform-ui-dev mailing list
platform-ui-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/platform-ui-dev
Attachment:
commit-templates.gif
Description: GIF image