mirror of
https://github.com/subsurface/subsurface.git
synced 2025-02-19 22:16:15 +00:00
Format commit message as code block
This commit is contained in:
parent
f296a81a14
commit
a64b70db4a
1 changed files with 19 additions and 17 deletions
36
README.md
36
README.md
|
@ -113,24 +113,26 @@ See: http://developercertificate.org/
|
|||
Also, please write good git commit messages. A good commit message
|
||||
looks like this:
|
||||
|
||||
Header line: explain the commit in one line (use the imperative)
|
||||
```
|
||||
Header line: explain the commit in one line (use the imperative)
|
||||
|
||||
Body of commit message is a few lines of text, explaining things
|
||||
in more detail, possibly giving some background about the issue
|
||||
being fixed, etc etc.
|
||||
|
||||
The body of the commit message can be several paragraphs, and
|
||||
please do proper word-wrap and keep columns shorter than about
|
||||
74 characters or so. That way "git log" will show things
|
||||
nicely even when it's indented.
|
||||
|
||||
Make sure you explain your solution and why you're doing what you're
|
||||
doing, as opposed to describing what you're doing. Reviewers and your
|
||||
future self can read the patch, but might not understand why a
|
||||
particular solution was implemented.
|
||||
|
||||
Reported-by: whoever-reported-it
|
||||
Signed-off-by: Your Name <youremail@yourhost.com>
|
||||
Body of commit message is a few lines of text, explaining things
|
||||
in more detail, possibly giving some background about the issue
|
||||
being fixed, etc etc.
|
||||
|
||||
The body of the commit message can be several paragraphs, and
|
||||
please do proper word-wrap and keep columns shorter than about
|
||||
74 characters or so. That way "git log" will show things
|
||||
nicely even when it's indented.
|
||||
|
||||
Make sure you explain your solution and why you're doing what you're
|
||||
doing, as opposed to describing what you're doing. Reviewers and your
|
||||
future self can read the patch, but might not understand why a
|
||||
particular solution was implemented.
|
||||
|
||||
Reported-by: whoever-reported-it
|
||||
Signed-off-by: Your Name <youremail@yourhost.com>
|
||||
```
|
||||
|
||||
where that header line really should be meaningful, and really should be
|
||||
just one line. That header line is what is shown by tools like gitk and
|
||||
|
|
Loading…
Add table
Reference in a new issue