From b98ece3e03f75d0f37bcb6f20f1ce1d859e0ecd3 Mon Sep 17 00:00:00 2001 From: Josh Cummings <3627351+jzheaux@users.noreply.github.com> Date: Mon, 3 Feb 2025 11:31:14 -0700 Subject: [PATCH] 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' --- CONTRIBUTING.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index e4f4b2d651..4f4d2a2d00 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -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] ----