Skip to main content

[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

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.


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>

"Eclipse Platform UI component developers list." <platform-ui-dev@xxxxxxxxxxx>
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


            "Mik Kersten"                                                
            Sent by:                                                   To
            platform-ui-dev-b         "'Eclipse Platform UI component    
            ounces@xxxxxxxxxx         developers list.'"                  
            g                         <platform-ui-dev@xxxxxxxxxxx>      
                                      "'Mylar developer discussions'"    
            12.09.2006 03:28          <mylar-dev@xxxxxxxxxxx>            
                                      RE: [platform-ui-dev] Commit        
            Please respond to         comment format for reporting of    
            "Eclipse Platform         bugs                                
              UI component                                                
            developers list."                                            

Mylar automatically generates similar commit comments.  I'm wondering if we
could come up with a standard format recommended across
projects.  On the Mylar project have been using a similar format for about
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}: {}\n${task.url}


 RESOLVED: 138666: [EditorMgmt] provide mechanism for restoring editors

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 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


> -----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
> 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
> into the commit dialog.
> Tod
> _______________________________________________
> platform-ui-dev mailing list
> platform-ui-dev@xxxxxxxxxxx
(See attached file: commit-templates.gif)
platform-ui-dev mailing list
platform-ui-dev mailing list

Attachment: commit-templates.gif
Description: GIF image

Back to the top