Skip to content

Commit d22ece3

Browse files
committed
Revise and reframe guidance for commit messages.
1 parent ae971f9 commit d22ece3

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,16 +50,15 @@ but don't rebase commits that are part of a pull request.
5050
Use the Git commit message to communicate with other contributors --
5151
both the people working on the project now
5252
who are reviewing your changes,
53-
and the people who will join the project in the future
54-
and will need to understand your changes.
55-
Well-written commit messages make it possible
56-
to come back to content later using tools like `git-blame`,
57-
and find the reason why the content is written that way.
53+
and people who join the project in the future
54+
who will need to understand what you changed and why.
5855

5956
Every commit starts with a one-sentence summary.
6057
The summary usually fits in 50 characters,
6158
but it's ok to exceed that amount occasionally
6259
if rewriting for brevity would make it too hard to read.
60+
If it's hard to write a good summary,
61+
try breaking your changes into multiple smaller commits.
6362

6463
If you can't explain the commit entirely in its summary,
6564
skip one line and add additional information.
@@ -70,9 +69,12 @@ alternatives you considered,
7069
and a summary of what you changed.
7170
Hard wrap these lines at 72 characters
7271
and leave a blank line between paragraphs.
73-
Remember that the body of a commit is plain text,
72+
The body of a commit is plain text,
7473
not markdown like the content of the book.
7574

75+
Following these formatting conventions in your commit
76+
makes it easier to read
77+
in places like the output from `git` and notification emails.
7678
Most text editors can help you write a commit message
7779
by marking lines that are too long
7880
and hard wrapping text automatically.

0 commit comments

Comments
 (0)