SubmittingPatches: write problem statement in the log in the present tense
We give a guidance for proposed log message to write problem statement first, followed by the reasoning behind, and recipe for, the solution. Clarify that we describe the situation _before_ the proposed patch is applied in the present tense (not in the past tense e.g. "we used to do X, but thanks to this commit we now do Y") for consistency. Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano committed
Jan 27, 2022 at 11:02 UTC
fa1101afb66dfb3ad325ad135b7bed59e4067dd5
1 file changed
+7
Documentation/SubmittingPatches
+7
@@ -142,6 +142,13 @@ The body should provide a meaningful commit message, which:
142
143
. alternate solutions considered but discarded, if any.
144
145
+[[present-tense]]
146
+The problem statement that describes the status quo is written in the
147
+present tense. Write "The code does X when it is given input Y",
148
+instead of "The code used to do Y when given input X". You do not
149
+have to say "Currently"---the status quo in the problem statement is
150
+about the code _without_ your change, by project convention.
151
+
152
[[imperative-mood]]
153
Describe your changes in imperative mood, e.g. "make xyzzy do frotz"
154
instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy