cybercyst/go
1
0
Fork 0
mirror of https://github.com/golang/go.git synced 2025-05-05 15:43:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated CommitMessage (markdown)

Brad Fitzpatrick 2018-05-15 12:26:33 -04:00
parent 804426509e
commit 98357a1dee
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CommitMessage.md

@ -1,6 +1,6 @@
# Commit messages
Commit messages, also known as CL (changelist) descriptions, should be formatted as follows:
Commit messages, also known as CL (changelist) descriptions, should be formatted per https://tip.golang.org/doc/contribute.html#commit_messages . For example,
```
net/http: frob the quux before blarfing
@ -16,11 +16,11 @@ Notably, for the subject (the first line of description):
* the part after the colon uses the verb tense + phrase that completes the blank in, *"This change modifies Go to ___________"*
* the verb after the colon is lowercase
* there is no trailing period
* it should be kept as short as possible (ideally, under 76 characters).
* it should be kept as short as possible (many git viewing tools prefer under ~76 characters, though Go isn't super strict about this).
For the body (the rest of the description):
* the text should be wrapped to 76 characters, unless you really need longer lines (e.g. for ASCII art, tables, or long links)
* the text should be wrapped to ~76 characters (to appease git viewing tools, mainly), unless you really need longer lines (e.g. for ASCII art, tables, or long links)
* the Fixes/Updates line goes after the body with a blank newline separating the two
* there is **no** Markdown in the commit message
* we **do not** use `Signed-off-by` lines. Don't add them. Our Gerrit server & GitHub bots enforce CLA compliance instead.