diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2022-02-11 16:55:58 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2022-02-11 16:55:58 -0800 |
| commit | 83760938bd18f81e5ecc1b6371ac396abc875d10 (patch) | |
| tree | 83db498a88551e60dabc944fec669185e59a7bb5 /Documentation/CodingGuidelines | |
| parent | Merge branch 'ab/no-errno-from-resolve-ref-unsafe' (diff) | |
| parent | SubmittingPatches: explain why we care about log messages (diff) | |
| download | tgif-83760938bd18f81e5ecc1b6371ac396abc875d10.tar.xz | |
Merge branch 'jc/doc-log-messages'
Update the contributor-facing documents on proposed log messages.
* jc/doc-log-messages:
SubmittingPatches: explain why we care about log messages
CodingGuidelines: hint why we value clearly written log messages
SubmittingPatches: write problem statement in the log in the present tense
Diffstat (limited to 'Documentation/CodingGuidelines')
| -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 |