Activity Team/Git Introduction: Difference between revisions

(2 intermediate revisions by one other user not shown)

Line 30:

== 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 just want to demonstrate your appreciation.

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] if 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 line summarizing the change (less than 50 characters), followed by a blank line and then a more thorough description (wrapped to 72 characters per line). This is because 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. Also, 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.

@@ Line 30: / Line 30: @@
 == 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 just want to demonstrate your appreciation.
+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] if 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 line summarizing the change (less than 50 characters), followed by a blank line and then a more thorough description (wrapped to 72 characters per line).  This is because 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.  Also, 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.