Login | Register For Free | Help
Search for: (Advanced)

Mailing List Archive: Wikipedia: Wikitech

git commit message guide lines

 

 

Wikipedia wikitech RSS feed   Index | Next | Previous | View Threaded


hashar+wmf at free

Mar 28, 2012, 11:06 AM

Post #1 of 1 (89 views)
Permalink
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 [at] lists
https://lists.wikimedia.org/mailman/listinfo/wikitech-l

Wikipedia wikitech RSS feed   Index | Next | Previous | View Threaded
 
 


Interested in having your list archived? Contact Gossamer Threads
 
  Web Applications & Managed Hosting Powered by Gossamer Threads Inc.