Git commits should include an empty line between title and description
See original GitHub issueHello @carloscuesta!
Git commits should have an empty line between the title and the description but currently, thereās none:
š Add Readme
This readme bla bla #1
should look like
š Add Readme
This readme bla bla #1
Issue Analytics
- State:
- Created 7 years ago
- Reactions:1
- Comments:9 (8 by maintainers)
Top Results From Across the Web
How add new empty-lines in the message of one-line ...
git commit -m 'message including subject' -m 'and body lines'. Every -m text separated with an empty line so this command will produce...
Read more >How to write a Git commit message properly with examples
In terms of formatting, there should always be an empty line between the subject line and the body. This space allows for various...
Read more >TIL About Adding a New Line to "git commit -m" - rockyourcode
The text up to the first blank line in a commit message is treated as the commit title, and that title is used...
Read more >Git Commit Message: Blank line between Subject & Body with ...
Enable all 4 Commit message inspects in Settings -> Version control -> Commit. Specifically, enable "Blank line between subject and body". Ā· Create...
Read more >Writing git commit messages that everybody understands
More detailed explanatory text. Wrap it to 72 characters. The blank line separating the summary from the body is critical (unless you omitĀ ......
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
I know itās a dated discussion, but google brought me here when searching about the commit blank line. Iāve found in the documentation a reference to it
That blank line allows to clearly separate the title of the commit from the summary. I couldnāt find an official reference for this but itās a some kind of standard. For instance when writing the commit with vim, itāll automatically break every 80 characters and highlight the background in red the second line to tell you you shouldnāt write anything there. A project using this is the erlang repo. On Google thereāre many posts saying that but I couldnāt find something from git. Maybe I read it on a book
On Sat, 4 Mar 2017, 11:09 Carlos Cuesta, notifications@github.com wrote: