CodingGuidelines: hint why we value clearly written log messages
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano committed
Jan 27, 2022 at 11:02 UTC
607817a3c8d2992f69e53c42dfa604b59d1570ba
1 file changed
+7
Documentation/CodingGuidelines
+7
@@ -26,6 +26,13 @@ code. For Git in general, a few rough rules are:
26
go and fix it up."
27
Cf. http://lkml.iu.edu/hypermail/linux/kernel/1001.3/01069.html
28
29
+ - Log messages to explain your changes are as important as the
30
+ changes themselves. Clearly written code and in-code comments
31
+ explain how the code works and what is assumed from the surrounding
32
+ context. The log messages explain what the changes wanted to
33
+ achieve and why the changes were necessary (more on this in the
34
+ accompanying SubmittingPatches document).
35
+
36
Make your code readable and sensible, and don't try to be clever.
37
38
As for more concrete guidelines, just imitate the existing code