Skip to content

Commit 607817a

Browse files
committed
CodingGuidelines: hint why we value clearly written log messages
Signed-off-by: Junio C Hamano <[email protected]>
1 parent fa1101a commit 607817a

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

Documentation/CodingGuidelines

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@ code. For Git in general, a few rough rules are:
2626
go and fix it up."
2727
Cf. http://lkml.iu.edu/hypermail/linux/kernel/1001.3/01069.html
2828

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+
2936
Make your code readable and sensible, and don't try to be clever.
3037

3138
As for more concrete guidelines, just imitate the existing code

0 commit comments

Comments
 (0)