From aba0775ad8a9b76df34df44d102526efc8a93493 Mon Sep 17 00:00:00 2001 From: Rob Pike Date: Tue, 17 Apr 2018 07:16:40 +1000 Subject: [PATCH] doc/contribute.html: adjust wording from previous CL The previous CL, 107197, overclarified the need for short subject lines. Tweak the wording to be a guideline (keep it short) rather than a limit (76 characters), which is more the Go way. Also be strict about avoiding markup language. Change-Id: I0da1132db8d86052647d96f1caac60289f2209ce Reviewed-on: https://go-review.googlesource.com/107378 Reviewed-by: Mohit Bajoria Reviewed-by: Brad Fitzpatrick --- doc/contribute.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/contribute.html b/doc/contribute.html index 91812a2afe..d592cfc54a 100644 --- a/doc/contribute.html +++ b/doc/contribute.html @@ -585,8 +585,8 @@ 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. Keep the first line as short as possible (ideally, under 76 characters).

+The first line of the change description is conventionally a short one-line +summary of the change, prefixed by the primary affected package.

It should be written so to complete the sentence "This change modifies Go to _____."

@@ -596,7 +596,7 @@ summary of the change, prefixed by the primary affected package. Keep the first change and explain what it does. Write in complete sentences with correct punctuation, just like for your comments in Go. -No Markdown should be used. +Don't use HTML, Markdown, or any other markup language.

Referencing issues

-- 2.48.1