From 7b6b5e340403c32756a92294729dc52f308b841a Mon Sep 17 00:00:00 2001 From: "Jeff R. Allen" Date: Wed, 25 May 2016 00:12:22 +0600 Subject: [PATCH] doc: add notes on good commit messages Explain Brad's algorithm for generating commit headlines. Fixes #15700 Change-Id: Ic602f17629b3dd7675e2bb1ed119062c03353ee9 Reviewed-on: https://go-review.googlesource.com/23355 Reviewed-by: Ian Lance Taylor Run-TryBot: Ian Lance Taylor TryBot-Result: Gobot Gobot --- doc/contribute.html | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/contribute.html b/doc/contribute.html index 1cd6f37d34..bcf7b25c51 100644 --- a/doc/contribute.html +++ b/doc/contribute.html @@ -353,10 +353,13 @@ with a thorough description of your change. The first line of the change description is conventionally a one-line summary of the change, prefixed by the primary affected package, and is used as the subject for code review mail. -The rest of the -description elaborates and should provide context for the +It should complete the sentence "This change modifies Go to _____." +The rest of the description elaborates and should provide context for the change and explain what it does. +Write in complete sentences with correct punctuation, just like +for your comments in Go. If there is a helpful reference, mention it here. +If you've fixed an issue, reference it by number with a # before it.

@@ -364,7 +367,7 @@ After editing, the template might now read: 

-math: improved Sin, Cos and Tan precision for very large arguments
+math: improve Sin, Cos and Tan precision for very large arguments
 
 The existing implementation has poor numerical properties for
 large arguments, so use the McGillicutty algorithm to improve