diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2022-01-27 11:02:58 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2022-01-27 17:50:04 -0800 |
| commit | 607817a3c8d2992f69e53c42dfa604b59d1570ba (patch) | |
| tree | 8cdc90f0f5d41ca4912806b85648e9239996046f /Documentation | |
| parent | SubmittingPatches: write problem statement in the log in the present tense (diff) | |
| download | tgif-607817a3c8d2992f69e53c42dfa604b59d1570ba.tar.xz | |
CodingGuidelines: hint why we value clearly written log messages
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/CodingGuidelines | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 0e27b5395d..c37c43186e 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -26,6 +26,13 @@ code. For Git in general, a few rough rules are: go and fix it up." Cf. http://lkml.iu.edu/hypermail/linux/kernel/1001.3/01069.html + - Log messages to explain your changes are as important as the + changes themselves. Clearly written code and in-code comments + explain how the code works and what is assumed from the surrounding + context. The log messages explain what the changes wanted to + achieve and why the changes were necessary (more on this in the + accompanying SubmittingPatches document). + Make your code readable and sensible, and don't try to be clever. As for more concrete guidelines, just imitate the existing code |