3,267
edits
Changes
Jump to navigation
Jump to search
Line 23:
Line 23: − +
Activity Team/Git Migration (view source)
Revision as of 07:20, 23 January 2009
, 07:20, 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.
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 just want to demonstrate your appreciation.
* 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.