Activity Team/Git Introduction: Difference between revisions
m moved Walter is a wanker 10/Git Introduction to Activity Team/Git Introduction over redirect: revert |
Sascha silbe (talk | contribs) →Commit message guidelines: prefix Sugar Labs tickets with SL, add links for example ticket references |
||
| Line 34: | Line 34: | ||
* 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). | * 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. | ||