3,267
edits
Changes
Activity Team/Git Migration (view source)
Revision as of 07:18, 23 January 2009
, 07:18, 23 January 2009→Git commit message guidelines
== Git commit message guidelines ==
== Git commit message guidelines ==
These are guidelines to enhance the readability of the commit messages and the release notes which are made with [http://www.kernel.org/pub/software/scm/git/docs/git-shortlog.html git-shortlog]. Please try to follow them as much as possible and make suggestions in the [ http://lists.sugarlabs.org/listinfo/sugar-devel sugar devel mailing list] of you find things missing, the guidelines completely insane or anything related.
* Though not required, it's a good idea to begin the commit message 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 the 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 Sugar Labs trac instance. If not please prepend an identifier like OLPC#123 and RH#456.
* 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://dev.sugarlabs.org Sugar Labs trac] instance. If not please prepend an identifier like OLPC#123 and RH#456.
* Start your commit message with a capital letter.
* Start your commit message with a capital letter.