Discussion:
[git] Git Commit message guidelines
David M Williams
2012-02-26 19:21:30 UTC
Permalink
I have seen at least a few projects discussing if/how to "standardize"
their Git commit messages. Such as

GEF:

http://dev.eclipse.org/mhonarc/lists/gef-dev/msg01541.html

Platform-UI:

http://dev.eclipse.org/mhonarc/lists/platform-ui-dev/msg05180.html

There seems to be a healthy back-and-forth discussion of pros and cons of
various approaches in those chains of mailing list messages (with differing
conclusions, if I'm skim reading them right).

It is certainly within each project's "rights" to decide how their project
committers should do it, but ...

I could not help but wonder if there should not be a bit larger
"eclipse-wide" discussion of "how to do it", such as
on this list? Or, would "architecture council list" be better? (Is this
list for more technical Git migration discussions?)

Perhaps there would end-up being some "common, minimum recommendation" ...
even if projects embellished on that common one?

Perhaps a "common" git wiki page with that recommendation and/or with
pointers off to the more project-specific practices would help improve
quality of Eclipse commit logs?

I'd be the last person to think all projects need to do it exactly the same
way ... but, I think a bit broader discussion would be good, and a bit of
knowledge sharing might help projects make the best choice for themselves,
especially for those new and unfamiliar with Git?

If anyone agrees, what would be best list to have that common discussion?

Thanks,
Andrew Overholt
2012-02-27 00:03:20 UTC
Permalink
Hi,
Post by David M Williams
Perhaps there would end-up being some "common, minimum recommendation" ...
even if projects embellished on that common one?
Did we have this for CVS?

FWIW, the Linux Tools git commit message guidelines are here:

http://wiki.eclipse.org/Linux_Tools_Project/Git#Commit_messages

Andrew
Paul Webster
2012-02-27 13:08:19 UTC
Permalink
Post by Andrew Overholt
Hi,
Post by David M Williams
Perhaps there would end-up being some "common, minimum recommendation"
...
Post by David M Williams
even if projects embellished on that common one?
Did we have this for CVS?
I don't believe so (although Platform UI has always tended to copy the
entire Bug # - title into the commit message).

Also FWIW, the EGit guidelines:
http://wiki.eclipse.org/EGit/Contributor_Guide#Commit_message_guidelines

I like the idea of adding bug and CQ numbers in the commit message footers,
it seems to be a common practice to have information there in git commit
messages.

Bug: NNNNN
CQ: NNNN

Later,
PW
--
Paul Webster
Hi floor. Make me a sammich! - GIR
Chris Aniszczyk
2012-02-27 16:40:46 UTC
Permalink
On Mon, Feb 27, 2012 at 5:08 AM, Paul Webster
Post by Paul Webster
I don't believe so (although Platform UI has always tended to copy the
entire Bug # - title into the commit message).
http://wiki.eclipse.org/EGit/Contributor_Guide#Commit_message_guidelines
I like the idea of adding bug and CQ numbers in the commit message footers,
it seems to be a common practice to have information there in git commit
messages.
Bug: NNNNN
CQ: NNNN
I personally find the EGit committer guidelines reasonable because if
you use Gerrit, the Bug and CQ text gets auto-linked. There's also the
possibility of using git-notes to adorn commit messages with this type
of information but no one has been pushing hard for this yet.
--
Cheers,

Chris Aniszczyk
http://aniszczyk.org
+1 512 961 6719
Steffen Pingel
2012-02-28 12:16:13 UTC
Permalink
We have an ongoing discussion around changing the guidelines for the
Mylyn project and potentially updating the default commit message
template that's included in Mylyn.

I have added the links from this thread but if anyone has further
input please feel free to chime in on the bug:

370038: Remove task state from commit message template for Mylyn projects
https://bugs.eclipse.org/bugs/show_bug.cgi?id=370038

Steffen
Post by Chris Aniszczyk
On Mon, Feb 27, 2012 at 5:08 AM, Paul Webster
Post by Paul Webster
I don't believe so (although Platform UI has always tended to copy the
entire Bug # - title into the commit message).
http://wiki.eclipse.org/EGit/Contributor_Guide#Commit_message_guidelines
I like the idea of adding bug and CQ numbers in the commit message footers,
it seems to be a common practice to have information there in git commit
messages.
Bug: NNNNN
CQ: NNNN
I personally find the EGit committer guidelines reasonable because if
you use Gerrit, the Bug and CQ text gets auto-linked. There's also the
possibility of using git-notes to adorn commit messages with this type
of information but no one has been pushing hard for this yet.
--
Cheers,
Chris Aniszczyk
http://aniszczyk.org
+1 512 961 6719
_______________________________________________
git mailing list
http://dev.eclipse.org/mailman/listinfo/git
--
Steffen Pingel
Senior Software Developer, Eclipse Mylyn
Mylyn Tasks Lead
http://tasktop.com
Loading...