2,751
edits
Changes
Jump to navigation
Jump to search
mLine 28:
Line 28: + + + + + + + + + + + + + + +
Activity Team/Git Introduction (view source)
Revision as of 14:49, 30 August 2009
, 14:49, 30 August 2009add commit message section
Likewise, as a project contributor, you get a place to host your contributions and provide feedback back into the projects ecosystem and easily collaborate with others on the same project. You get your own personal clone of the project on the site that you can work freely in and a way to package up your changes and notify the other project members about your changes.
Likewise, as a project contributor, you get a place to host your contributions and provide feedback back into the projects ecosystem and easily collaborate with others on the same project. You get your own personal clone of the project on the site that you can work freely in and a way to package up your changes and notify the other project members about your changes.
== 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.
* 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.
* Start your commit message with a capital letter.
* Suffix no dot at the end of the summarizing line.
* Fixes for typing errors and pylint fixes happen quite often. Just mark them _Typo and respectively _Pylint for easier reading.
----
[[Category:Activity Team]]
[[Category:Activity Team]]