Revision: 1763
Author: ross.gardler
Date: Fri Nov 27 08:11:45 2009
Log: How to write a commit log
http://code.google.com/p/simal/source/detail?r=1763
Added:
/wiki/CommitterNotes.wiki
=======================================
--- /dev/null
+++ /wiki/CommitterNotes.wiki Fri Nov 27 08:11:45 2009
@@ -0,0 +1,59 @@
+#summary Records useful information for committers
+#labels Phase-QA
+
+= Commit log =
+
+The commit log is a very important tool in our IP and Issue management
chain. All commit logs should be in the form of:
+
+{{{
+Your commit log message descriptive text...
+
+COMMAND-LINE
+ISSUE-FIELD-UPDATE*
+COMMENT-TEXT...
+}}}
+
+
+== Log Message ==
+
+All log messages should be concise and clear. Bear in mind that reviewers
want to be able to see at a glance what the patch is intended to do.
+
+If your commit closes and issue then you should include "(fixes issue
####}", for example:
+
+{{{
+Ensure we check for foo when we do bar (fixes issue 123)
+}}}
+
+=== Credits ===
+
+If the patch has been supplied by another contributor then you are taking
responsibility for that commit, in other words you must have fully reviewed
the patch. You must also credit them by name and reference the issue from
your commit message. For example:
+
+{{{
+Ensure we check for foo when we do bar. Thanks to Jane Doe. (fixes issue
123)
+}}}
+
+== Requesting a review ==
+
+We operate a commit then review policy for committers. For all but the
simplest of commits you should request a code review. To do this simply
include "new review" in the "COMMAND_LINE" of your commit log, for example:
+
+{{{
+Ensure we check for foo when we do bar. (fixes issue 123)
+
+new review
+}}}
+
+== Updating issues ==
+
+You can (and should) update issues from commit messages using "update
issue ###". For example:
+
+{{{
+Ensure we check for foo when we do bar. (fixes issue 123)
+
+new review
+update issue 999
+Applied patch to check foo in issue 123, once review is complete we can
proceed with this issue.
+}}}
+
+= Further Reading =
+
+ *
[http://code.google.com/p/support/wiki/IssueTracker#Integration_with_version_control
Integrating the issue tracker with version control]
--
You received this message because you are subscribed to the Google Groups
"Simal Commits" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/simal-commits?hl=en.
