mirror
/
go
mirror of https://github.com/golang/go.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: improve commit messages 

Fixes #24852

Change-Id: I71d0d7f75108bf4ad606733a45bb71baa66a4e91
Reviewed-on: https://go-review.googlesource.com/107197
Reviewed-by: Alberto Donizetti <alb.donizetti@gmail.com>
Reviewed-by: Giovanni Bajo <rasky@develer.com>
This commit is contained in:
mbj36 2018-04-15 22:50:14 +05:30 committed by Giovanni Bajo
parent a5085f82a5
commit 1898fce1e7
1 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/contribute.html
View File

@ -579,13 +579,14 @@ The algorithm is described at http://wikipedia.org/wiki/McGillicutty_Algorithm
Fixes #159
</pre>
</p>
<h3>First line</h3>
<p>
The first line of the change description is conventionally a one-line
summary of the change, prefixed by the primary affected package.</p>
summary of the change, prefixed by the primary affected package. Keep the first line as short as possible (ideally, under 76 characters).</p>
<p>It should be written so to complete the sentence "This change modifies Go to _____."</p>
@ -595,7 +596,7 @@ summary of the change, prefixed by the primary affected package.</p>
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.
</p>
<h3>Referencing issues</h3>
@ -621,10 +622,6 @@ linked to the issue in the main repository. The correct form is "Fixes golang/go
</p>
<h2 id="review">The review process</h2>
<p>