344
edits
Changes
Activity Team/Git Introduction (view source)
Revision as of 16:10, 15 April 2011
, 16:10, 15 April 2011→Commit message guidelines: prefix Sugar Labs tickets with SL, add links for example ticket references
* The commit message should start with a single short (less than 50 character) line summarizing the change, followed by a blank line and then a more thorough description. Tools that turn commits into email, for example, use the first line on the Subject: line and the rest of the commit in the body. The git-shortlog command that we use to write the release notes will strip the more detailed description.
* The commit message should start with a single short (less than 50 character) line summarizing the change, followed by a blank line and then a more thorough description. Tools that turn commits into email, for example, use the first line on the Subject: line and the rest of the commit in the body. The git-shortlog command that we use to write the release notes will strip the more detailed description.
* If your commit does fix a certain bug make sure that the summarizing line contains the bug number prepended by a '#' at the '''end''' of the line (e.g. #14). It is implied that you mean the [http://trac.sugarlabs.org Sugar Labs trac] instance. If not please prepend an identifier like OLPC#123, RH#456, Debian#666, Ubuntu#53.
* If your commit does fix a certain bug make sure that the summarizing line contains the bug number prepended by a '#' at the '''end''' of the line (e.g. #14). Please prepend an identifier indicating the bug tracker, e.g. [http://bugs.sugarlabs.org/ticket/342 SL#342], [http://dev.laptop.org/ticket/9358 OLPC#9358], [https://bugzilla.redhat.com/show_bug.cgi?id=482949 RH#482949], [http://bugs.debian.org/555965 Debian#555965], [https://bugs.launchpad.net/sugar/+bug/480407 Ubuntu#480407].
* Start your commit message with a capital letter.
* Start your commit message with a capital letter.