mirror of
https://github.com/spring-projects/spring-security.git
synced 2025-05-29 08:12:14 +00:00
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'
This commit is contained in:
parent
6730167445
commit
b98ece3e03
@ -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…
x
Reference in New Issue
Block a user