Skip to content

Commit

Permalink
Clarify Commit Message Guideline
Browse files Browse the repository at this point in the history
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'
  • Loading branch information
jzheaux committed Feb 3, 2025
1 parent 6730167 commit b98ece3
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand Down

0 comments on commit b98ece3

Please sign in to comment.