mifr/subsurface
1
0
Fork 0
mirror of https://github.com/subsurface/subsurface.git synced 2025-02-19 22:16:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

Format commit message as code block

Browse source
This commit is contained in:
probonopd 2017-11-04 14:36:01 +01:00 • committed by Dirk Hohndel
parent f296a81a14
commit a64b70db4a
1 changed files with 19 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -113,24 +113,26 @@ See: http://developercertificate.org/
Also, please write good git commit messages. A good commit message Also, please write good git commit messages. A good commit message
looks like this: 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 Body of commit message is a few lines of text, explaining things
in more detail, possibly giving some background about the issue in more detail, possibly giving some background about the issue
being fixed, etc etc. being fixed, etc etc.
The body of the commit message can be several paragraphs, and The body of the commit message can be several paragraphs, and
please do proper word-wrap and keep columns shorter than about please do proper word-wrap and keep columns shorter than about
74 characters or so. That way "git log" will show things 74 characters or so. That way "git log" will show things
nicely even when it's indented. nicely even when it's indented.
Make sure you explain your solution and why you're doing what you're 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 doing, as opposed to describing what you're doing. Reviewers and your
future self can read the patch, but might not understand why a future self can read the patch, but might not understand why a
particular solution was implemented. particular solution was implemented.
Reported-by: whoever-reported-it Reported-by: whoever-reported-it
Signed-off-by: Your Name <youremail@yourhost.com> Signed-off-by: Your Name <youremail@yourhost.com>
```
where that header line really should be meaningful, and really should be 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 just one line. That header line is what is shown by tools like gitk and