Browse Source

Clarify Commit Message Guideline

We typically use imperative; however, this can feel unnatural on occasion.
For example 'S101 Depends On Assemble' would sound unnatural as 'S101 Depend On Assemble'
pull/16214/head
Josh Cummings 11 months ago
parent
commit
b98ece3e03
No known key found for this signature in database
GPG Key ID: 869B37A20E876129
  1. 2
      CONTRIBUTING.adoc

2
CONTRIBUTING.adoc

@ -112,7 +112,7 @@ See https://git-scm.com/book/en/Git-Tools-Rewriting-History[Rewriting History se @@ -112,7 +112,7 @@ See https://git-scm.com/book/en/Git-Tools-Rewriting-History[Rewriting History se
11. [[format-commit-messages]] Format commit messages using 55 characters for the subject line, 72 characters per line
for the description, followed by the issue fixed, for example, `Closes gh-22276`.
See the https://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines[Commit Guidelines section of Pro Git] for best practices around commit messages, and use `git log` to see some examples.
Present tense is preferred.
Favor imperative tense over present tense (use "Fix" instead of "Fixes"); avoid past tense (use "Fix" instead of "Fixed").
+
[indent=0]
----

Loading…
Cancel
Save