Mailing List Archive

git commit message guide lines
Hello,

With the switch to git and Gerrit, we should start formatting our commit
message. Over the last days, you might have noticed I have amended a few
changes in mediawiki/core.git.

Both git and gerrit use the first line of a message as a summary of the
commit which is probably more human friendly than a sha1.

In Gerrit it is used when referring to a parent commit and as a subject
for email notifications.
In git it is very helpful when using `log --oneline` or cherry-picking a
commit, or rebasing interactively.


Inspired by various online resources, I have started writing guidelines
and even provided some screen captures:

https://www.mediawiki.org/wiki/Git/Commit_message_guidelines

Edits welcome :-D


See also:
http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
http://en.wikibooks.org/wiki/Git/Introduction#Good_commit_messages


--
Antoine "hashar" Musso



_______________________________________________
Wikitech-l mailing list
Wikitech-l@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikitech-l