Skip to content

Commit a00ae75

Browse files
lpincaFishrock123
authored andcommitted
doc: improve documentation for commit subject line
Specify that commit subject line must be made of only lowercase words and should start with an imperative verb. PR-URL: #8546 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
1 parent aaebbf9 commit a00ae75

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,15 +93,19 @@ Writing good commit logs is important. A commit log should describe what
9393
changed and why. Follow these guidelines when writing one:
9494

9595
1. The first line should be 50 characters or less and contain a short
96-
description of the change prefixed with the name of the changed
97-
subsystem (e.g. "net: add localAddress and localPort to Socket").
96+
description of the change. All words in the description should be in
97+
lowercase with the exception of proper nouns, acronyms, and the ones that
98+
refer to code, like function/variable names. The description should
99+
be prefixed with the name of the changed subsystem and start with an
100+
imperative verb, for example, "net: add localAddress and localPort
101+
to Socket".
98102
2. Keep the second line blank.
99103
3. Wrap all other lines at 72 columns.
100104

101105
A good commit log can look something like this:
102106

103107
```txt
104-
subsystem: explaining the commit in one line
108+
subsystem: explain the commit in one line
105109
106110
Body of commit message is a few lines of text, explaining things
107111
in more detail, possibly giving some background about the issue

0 commit comments

Comments
 (0)