File tree Expand file tree Collapse file tree 1 file changed +7
-3
lines changed Expand file tree Collapse file tree 1 file changed +7
-3
lines changed Original file line number Diff line number Diff line change @@ -93,15 +93,19 @@ Writing good commit logs is important. A commit log should describe what
9393changed and why. Follow these guidelines when writing one:
9494
95951 . 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".
981022 . Keep the second line blank.
991033 . Wrap all other lines at 72 columns.
100104
101105A 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
106110Body of commit message is a few lines of text, explaining things
107111in more detail, possibly giving some background about the issue
You can’t perform that action at this time.
0 commit comments