Re: [platform-ui-dev] Commit message guidelines

[Eric Moffatt <emoffatt@xxxxxxxxxx>]

I also am in favor of keeping the check
in notice simple, I simply copy the top line from bugzilla ("Fix for
Bug xxxx - Bug Title"), then I put comments on the defect if there's
anything funky about the new code...

What would be way cool would be to 'tool
up' so that clicking on the check in notice would open the defect reference
in the notice...

Eric

From:	John Arthorne/Ottawa/IBM@IBMCA
To:	"Eclipse Platform UI component developers list." <platform-ui-dev@xxxxxxxxxxx>
Date:	02/23/2012 03:01 PM
Subject:	Re: [platform-ui-dev] Commit message guidelines
Sent by:	platform-ui-dev-bounces@xxxxxxxxxxx

---

Personally I think the bug number and
summary like we do today is sufficient. The best place for a long-winded
explanation of the change is bugzilla, so that it is in a structured format,
and associated with all the discussion, steps to reproduce, target milestone,
etc, and gets sent to the bug's CC list. Also this allows you to add further
comments after the git commit has been made without destroying the commit
hash. A Git commit comment is a very poor vehicle for structured data compared
to bugzilla. 

I have a suspicion some of the existing conventions related to git comments
come from projects that don't have a separate bug tracker. I'd be looking
for some value other than "this is what other people do" before
we create too much work for ourselves. Yes, it is possible our commit comments
might some day be converted into emails and then read by someone who uses
PINE, but it doesn't feel like the case to optimize for on a team building
21st century graphical IDEs ;) 

John

Paul Webster <pwebster@xxxxxxxxxxxxxxxxxxx>
Sent by: platform-ui-dev-bounces@xxxxxxxxxxx

02/23/2012 08:51 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	[platform-ui-dev] Commit message guidelines

I'm interested in adopting a git comment convention [1] for our comments
in Platform/UI.  I hope to accomplish 3 things:

1) align ourselves with the common practice for git comments [2]

2) use one that's already been adapted by an eclipse project

3) prepare for when we use Gerrit for reviews and contributions.

The gist of the comment format from [1]:

"Brief Title, less than 60 chars
[blank line]
quick or long description of the change, either code or behaviour.  The
commit 
comment area auto-wraps this.
[blank line]
Bug: bug#"

Please think about this, comments are welcome on the mailing list.  We'll
make a call during milestone week and adopt it in M7.  Also I'll just
comment on #3, we have no plans to adopt Gerrit before Juno ships to avoid
the potential disruption.

[1] http://wiki.eclipse.org/EGit/Contributor_Guide#Commit_message_guidelines

[2] http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

-- 
Paul Webster
Hi floor.  Make me a sammich! - GIR_______________________________________________
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