From 1898fce1e70b0a2038d71363d38e8b10b269c1c4 Mon Sep 17 00:00:00 2001
From: mbj36
Date: Sun, 15 Apr 2018 22:50:14 +0530
Subject: [PATCH] doc: improve commit messages
Fixes #24852
Change-Id: I71d0d7f75108bf4ad606733a45bb71baa66a4e91
Reviewed-on: https://go-review.googlesource.com/107197
Reviewed-by: Alberto Donizetti
Reviewed-by: Giovanni Bajo
---
doc/contribute.html | 9 +++------
1 file changed, 3 insertions(+), 6 deletions(-)
diff --git a/doc/contribute.html b/doc/contribute.html
index 4664f65069..91812a2afe 100644
--- a/doc/contribute.html
+++ b/doc/contribute.html
@@ -579,13 +579,14 @@ The algorithm is described at http://wikipedia.org/wiki/McGillicutty_Algorithm
Fixes #159
+
First line
The first line of the change description is conventionally a one-line
-summary of the change, prefixed by the primary affected package.
+summary of the change, prefixed by the primary affected package. Keep the first line as short as possible (ideally, under 76 characters).
It should be written so to complete the sentence "This change modifies Go to _____."
@@ -595,7 +596,7 @@ summary of the change, prefixed by the primary affected package.
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.
+No Markdown should be used.
Referencing issues
@@ -621,10 +622,6 @@ linked to the issue in the main repository. The correct form is "Fixes golang/go
-
-
-
-
The review process
--
2.50.0