atom/github

Add blank line between title and message in commits

Open

#791 opened on May 12, 2017

View on GitHub
 (4 comments) (1 reaction) (0 assignees)JavaScript (1,069 stars) (469 forks)batch import
gitgood first issue

Description

Description

There should be a blank line between the "title" of a commit message and the full description of the message.

Steps to Reproduce

  1. Stage a file for committing
  2. Write a title (should have a character count on this line), hit enter.
  3. Write a description (should have ∞ as the character count)
  4. Commit the change
  5. View the log

Expected behavior:

Resulting commit message matches what other tools produce.

Actual behavior:

Atom fails to insert a blank line between the title and the detailed description.

Reproduces how often:

100% of the time.

Versions

github@0.0.6

Tested on a custom Atom build based on merging https://github.com/atom/atom/pull/12696/commits/96533998e2da5ee8f3adadc86efb48e9405ae6e5 and https://github.com/atom/atom/pull/13691/commits/4f1b5b70b54e6704037c47b177138afd7465a98f into https://github.com/atom/atom/commit/1992c17399249a67f74418ee1d75db0f8a0ccfae.

Atom : 1.18.0-dev-969a4da6c Electron: 1.6.9 Chrome : 56.0.2924.87 Node : 7.4.0

git: git version 2.13.0.windows.1

GitKraken: v2.5.0

Additional Information

Atom: image

git CLI: image Note how it highlights any text placed on that line in orange/red!

As an example of how other implementations handle this, here's GitKraken: image

Result: image

When viewing the commits on GitHub it handles the lack of a blank line in the same manner as the other tools, but as the blank line is what the official git client does and what other tools do it would be good to follow their lead. It also makes parsing of the messages simpler 😉.

Contributor guide