Skip to Content.
Sympa Menu

sm-commit - Re: [SM-Commit] GIT changes to master grimoire by Sukneet Basuta (c76c47440ca8102426104877fea826350750fa19)

sm-commit AT lists.ibiblio.org

Subject: Source Mage code commit list

List archive

Chronological Thread  
  • From: flux <flux AT sourcemage.org>
  • To: sm-commit AT lists.ibiblio.org
  • Subject: Re: [SM-Commit] GIT changes to master grimoire by Sukneet Basuta (c76c47440ca8102426104877fea826350750fa19)
  • Date: Thu, 8 Apr 2010 19:18:44 +0900

Sukneet Basuta (scm AT sourcemage.org) wrote [10.04.08 17:34]:
> GIT changes to master grimoire by Sukneet Basuta <sukneet AT sourcemage.org>:
>
> mail/mutt/CONFIGURE | 8 ++++++--
> mail/mutt/DEPENDS | 15 +++++++++++++--
> mail/mutt/HISTORY | 6 ++++++
> 3 files changed, 25 insertions(+), 4 deletions(-)
>
> New commits:
> commit c76c47440ca8102426104877fea826350750fa19
> Author: Sukneet Basuta <sukneet AT sourcemage.org>
> Commit: Sukneet Basuta <sukneet AT sourcemage.org>
>
> mutt: added SMTP configure opt
> fixed cyrus-sasl config opt
> fixed ncurses config opt
> added ispell opt depends

Ideally you should have the first line say something like:

mutt: fixed optional configure/depends

followed by a blank line and then a summary of what config/depends you
had fixed. The reason why is that when you do git log pretty=oneline or
a similar compressed option, only the first line of the commit message
is shown. Git basically treats the first line of a commit message like
the Subject: field of an email, with a blank line separating the
email Subject: from the email body (the summary that comes after). If
someone is not extra careful when looking through git logs, they may
misinterpret your change and revert it or cherry-pick it (or something
else) for the wrong reason (maybe not so likely, but it's a hypothetical
to consider).

This isn't required practice/policy, but it's recommended (and there are
other reasons besides what I listed above). For information on git
commit message formatting recommendations (and the reasons why), see the
git-commit man page (man git-commit or git help commit) and also the
following url:

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

Also, there are others whose commits also "violate" the above
recommendation(s), but I'm too lazy to hunt them down right now and
point it out. If you're reading this, you should know if your commit
messages are formatted nicely. ;)

Again, the above is a recommendation, as we don't have policy about it
(to my knowledge).

--
Justin "flux_control" Boffemmyer
Cauldron wizard and general mage
Source Mage GNU/Linux
http://www.sourcemage.org

Attachment: pgpNY7LU8srD9.pgp
Description: PGP signature




Archive powered by MHonArc 2.6.24.

Top of Page