OK, I have deleted the branches and updated the contribution guide to what we have decided w.r.t. to the commit messages. Please have a look if everything is ok there, now.
Cheers Alexander Am 07.03.2012 um 03:20 schrieb Anthony Hunter: No objections for deleting the branches.
Cheers...
Anthony
From:
Alexander Nyßen <alexander.nyssen@xxxxxxxxx>
To:
GEF development <gef-dev@xxxxxxxxxxx>
Date:
2012/03/05 02:22 PM
Subject:
Re: [gef-dev]
Git Commit Logs
Sent by:
gef-dev-bounces@xxxxxxxxxxx
Anthony,
would be nice to have your opinion on this one, as we
can then close the issue and update the contribution guide accordingly.
Not directly related to this, but also a kind of request-for-decision:
I would like to propose that we clean-up our Git repository be deleting
the "ArcFix" and "TYCHO_BUILD_MIGRATION" branches,
which do not seem to be useful any more (BTW they are also archived in
the CVS repository). Any objections?
Cheers
Alexander
Am 27.02.2012 um 09:58 schrieb Alexander Nyssen:
+1 from me, as long as the short line (respectively the
short-line summary) includes the related bug id, as well as the related
CQ id in case of a contribution.
Cheers,
Alexander
Am 26.02.2012 um 16:42 schrieb Fabian Steeg:
Hi all,
I agree it would make sense to use a simplified commit
message format. I think we can simplify the format further by not including
the contributor in the message, but using the Git author field instead.
This approach is also recommended on the Eclipse wiki [1].
For the commit message I agree it should explain why a
change was made. To have a well readable commit log, I suggest we adopt
two common Git practices [2]:
1) If a message is longer than one short line, it should
be formatted to have a short, one-line summary, a blank line, and a wrapped
longer description.
2) To be consisten with Git's generated messages (like
'Merge branch...'), we should use present tense to descibe what a commit
does (like 'Add support...').
Cheers,
Fabian
[1] http://wiki.eclipse.org/Development_Resources/Handling_Git_Contributions
[2] http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
On 25.02.2012, at 22:04, Alexander Nyßen wrote:
Hi Ed,
yes, that's a point. However, I simply wanted to emphasize
that it should not match be the bug title but be a reasonable commit message.
Whether the WHAT or the WHY is the more important information may probably
differ from case to case so I think the committer should have the freedom
to decide.
Cheers
Alexander
Am 25.02.2012 um 15:57 schrieb Ed Willink:
Hi Alexander
Somewhere, I think in the EGIT guide, is the recommendation that the commit
message should be
WHY the change was made
since WHAT was changed can be reconstructed, but the motivation is easily
lost forever.
Regards
Ed Willink
On 25/02/2012 13:49, Alexander Nyssen wrote:
Hi all,
I just wanted to start reworking the Contributor Guide
to reflect our changed project infrastructure.
As it provides guidance on how to format commit logs,
I think we should first agree on how we want to do this for GEF (and GEF4)
in the future. I think the old cvs-inspired format of kind
[213359] gef-head crevells 071221
Make GEF's snapping and tools extensible to allow moving shapes with arrow
keys
seems to be a bit cumbersome, now that we have Git in
place. I would like to propose something like the following:
[<bug-id>] (<contributor>)? <commit-message>.
where <bug-id> is the id of the bug the commit is
related to, or NONE in case the commit is not directly related to any bug.
<contributor> is the full name of the contributor in case the contribution
is not done by the committer itself. In case the committer also is the
contributor it may be left out. The commit message should not equal the
title of the related bug (one can read it there) but should instead describe
the performed changes. Two examples:
[355997] (Matthias Wienand) Added support
for calculating bezier curve intersections by means of bezier clipping
algorithm. (CQ 5976)
[NONE] Updated target definition to Eclipse
SDK 4.2.0.I20120222-0915.
What do you think?
--
Dr. Alexander Nyßen
Dipl.-Inform.
Software-Engineer
Telefon: +49 (0) 231 / 98 60-210
Telefax: +49 (0) 231 / 98 60-211
Mobil: +49 (0) 151 / 17396743
http://www.itemis.de
alexander.nyssen@xxxxxxxxx
itemis AG
Am Brambusch 15-24
44536 Lünen
Rechtlicher Hinweis:
Amtsgericht Dortmund, HRB 20621
Vorstand: Jens Wagener (Vors.), Wolfgang Neuhaus, Dr. Georg Pietrek, Jens
Trompeter, Sebastian Neus
Aufsichtsrat: Dr. Burkhard Igel (Vors.), Stephan Grollmann, Michael Neuhaus
_______________________________________________
gef-dev mailing list
gef-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/gef-dev
-----
No virus found in this message.
Checked by AVG - www.avg.com
Version: 2012.0.1913 / Virus Database: 2114/4830 - Release Date: 02/24/12
_______________________________________________
gef-dev mailing list
gef-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/gef-dev
--
Dr. Alexander Nyßen
Dipl.-Inform.
Software-Engineer
Telefon: +49 (0) 231 / 98 60-210
Telefax: +49 (0) 231 / 98 60-211
Mobil: +49 (0) 151 / 17396743
http://www.itemis.de
alexander.nyssen@xxxxxxxxx
itemis AG
Am Brambusch 15-24
44536 Lünen
Rechtlicher Hinweis:
Amtsgericht Dortmund, HRB 20621
Vorstand: Jens Wagener (Vors.), Wolfgang Neuhaus, Dr. Georg Pietrek, Jens
Trompeter, Sebastian Neus
Aufsichtsrat: Dr. Burkhard Igel (Vors.), Stephan Grollmann, Michael Neuhaus
_______________________________________________
gef-dev mailing list
gef-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/gef-dev
_______________________________________________
gef-dev mailing list
gef-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/gef-dev
--
Dr. Alexander Nyßen
Dipl.-Inform.
Software-Engineer
Telefon: +49 (0) 231 / 98 60-210
Telefax: +49 (0) 231 / 98 60-211
Mobil: +49 (0) 151 / 17396743
http://www.itemis.de
alexander.nyssen@xxxxxxxxx
itemis AG
Am Brambusch 15-24
44536 Lünen
Rechtlicher Hinweis:
Amtsgericht Dortmund, HRB 20621
Vorstand: Jens Wagener (Vors.), Wolfgang Neuhaus, Dr. Georg Pietrek, Jens
Trompeter, Sebastian Neus
Aufsichtsrat: Dr. Burkhard Igel (Vors.), Stephan Grollmann, Michael Neuhaus
_______________________________________________
gef-dev mailing list
gef-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/gef-dev
--
Dr. Alexander Nyßen
Dipl.-Inform.
Software-Engineer
Telefon: +49 (0) 231 / 98 60-210
Telefax: +49 (0) 231 / 98 60-211
Mobil: +49 (0) 151 / 17396743
http://www.itemis.de
alexander.nyssen@xxxxxxxxx
itemis AG
Am Brambusch 15-24
44536 Lünen
Rechtlicher Hinweis:
Amtsgericht Dortmund, HRB 20621
Vorstand: Jens Wagener (Vors.), Wolfgang Neuhaus, Dr. Georg Pietrek, Jens
Trompeter, Sebastian Neus
Aufsichtsrat: Dr. Burkhard Igel (Vors.), Stephan Grollmann, Michael Neuhaus
_______________________________________________
gef-dev mailing list
gef-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/gef-dev
_______________________________________________ gef-dev mailing list gef-dev@xxxxxxxxxxx https://dev.eclipse.org/mailman/listinfo/gef-dev
-- Dr. Alexander Nyßen Dipl.-Inform. Software-Engineer Telefon: +49 (0) 231 / 98 60-210 Telefax: +49 (0) 231 / 98 60-211 Mobil: +49 (0) 151 / 17396743 http://www.itemis.de alexander.nyssen@xxxxxxxxx itemis AG Am Brambusch 15-24 44536 Lünen Rechtlicher Hinweis: Amtsgericht Dortmund, HRB 20621 Vorstand: Jens Wagener (Vors.), Wolfgang Neuhaus, Dr. Georg Pietrek, Jens Trompeter, Sebastian Neus Aufsichtsrat: Dr. Burkhard Igel (Vors.), Stephan Grollmann, Michael Neuhaus
|