Mention "local convention" rule in the CodingGuidelines
authorNanako Shiraishi <nanako3@lavabit.com>
Mon, 26 Jan 2009 08:32:22 +0000 (17:32 +0900)
committerJunio C Hamano <gitster@pobox.com>
Mon, 26 Jan 2009 08:35:58 +0000 (00:35 -0800)
The document suggests to imitate the existing code, but didn't
say which existing code it should imitate. This clarifies.

Signed-off-by: しらいしななこ <nanako3@lavabit.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/CodingGuidelines

index f628c1f3b7b706f9d585b96041e5a4b12bc0f62c..0d7fa9cca9e5c3ec8a11cd2c878f5a7afe353abe 100644 (file)
@@ -21,8 +21,13 @@ code.  For git in general, three rough rules are:
 
 As for more concrete guidelines, just imitate the existing code
 (this is a good guideline, no matter which project you are
-contributing to).  But if you must have a list of rules,
-here they are.
+contributing to). It is always preferable to match the _local_
+convention. New code added to git suite is expected to match
+the overall style of existing code. Modifications to existing
+code is expected to match the style the surrounding code already
+uses (even if it doesn't match the overall style of existing code).
+
+But if you must have a list of rules, here they are.
 
 For shell scripts specifically (not exhaustive):