Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[mylyn-dev] Commit messages

While reviewing this contribution I've come across a commit message that differs from our usual format:

6020: bug 379783: [WikiText] Expand MediaWiki template recursively. [I84f80792]

The commit message looks like this:

Parent:     2ca48ed1 (bug 358671: Add support for fallback items https://bugs.eclipse.org/bugs/show_bug.cgi?id=358671)
Author:     Jeremie Bresson <dev@xxxxxxxx>
AuthorDate: 2012-05-25 13:33:51 +0200
Commit:     jmini <dev@xxxxxxxx>
CommitDate: 2012-05-25 13:33:51 +0200

bug 379783: [WikiText] Expand MediaWiki template recursively.


Added (v2): Loop detection and unit tests.
Added (v3): Corrections from code review.

Change-Id: I84f8079275f090c662186f9cf47311f688347b0b

Looking at the contributor reference (http://wiki.eclipse.org/Mylyn/Contributor_Reference) it seems that our guidelines on commit messages are pretty loose.  The format that I'm used to seeing (on Mylyn) is more like this:

379783: [WikiText] Expand MediaWiki template recursively

Add support for nested template references with loop detection

Change-Id: I84f8079275f090c662186f9cf47311f688347b0b

There is some related discussion on this bug:

370038: Remove task state from commit message template for Mylyn projects

My feeling is that we should be standardizing on commit message formats, and that the format should be supported/encouraged by the commit message template.  I'm interested to hear opinions from others, and would like to have clear guidelines in the contributor reference (even if those guidelines say that we have no specific format).

David

--
David Green
VP of Engineering, Tasktop
Committer, Eclipse Mylyn
http://tasktop.com 
+1-778-588-6896 ext. 115



Back to the top