Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[eclipse-dev] Moving the Bug reference to the meta data in the Git commit footer?

Hi,

We currently add the Bug reference to the commit header in our Git
commit message.

I personally prefer the "Git style" for adding meta information for commits.
In this style (used for example by EGit) additional metadata is placed
in the footer as key/value pair.

I think now that we made Bug reports optional for cleanup commits, our
history would read better if we move the bug reference to the commit
footer.

For example, our commit message currently is:

----------
Bug 535192 - Update Comparator repo and eclipse run repo to 4.9-I-builds
repo

Change for eclipse.platform.ui

Change-Id: Id80583a8389421524b19e3b2cac8e2a102a3f94e
Signed-off-by: Lars Vogel <Lars.Vogel@xxxxxxxxxxx>
---------------

Using the footer for metadata this would be:

-----------
Update Comparator repo and eclipse run repo to 4.9-I-builds repo

Change for eclipse.platform.ui

Bug: 535192
Change-Id: Id80583a8389421524b19e3b2cac8e2a102a3f94e
Signed-off-by: Lars Vogel <Lars.Vogel@xxxxxxxxxxx>
-----------

Both styles are supported by the foundation for linking to Bugzilla
and updating Bugzilla with commit information.

WDYT?

Best regards, Lars

-- 
Eclipse Platform project co-lead
CEO vogella GmbH

Haindaalwisch 17a, 22395 Hamburg
Amtsgericht Hamburg: HRB 127058
Geschäftsführer: Lars Vogel, Jennifer Nerlich de Vogel
USt-IdNr.: DE284122352
Fax (040) 5247 6322, Email: lars.vogel@xxxxxxxxxxx, Web: http://www.vogella.com


Back to the top