mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

CodingGuidelines: hint why we value clearly written log messages

Browse Source 
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Junio C Hamano
2022-01-27 11:02:58 -08:00
parent fa1101afb6
commit 607817a3c8
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/CodingGuidelines
View File

@ -26,6 +26,13 @@ code. For Git in general, a few rough rules are:
go and fix it up." go and fix it up."
Cf. http://lkml.iu.edu/hypermail/linux/kernel/1001.3/01069.html 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. Make your code readable and sensible, and don't try to be clever.
As for more concrete guidelines, just imitate the existing code As for more concrete guidelines, just imitate the existing code