X-Git-Url: https://asedeno.scripts.mit.edu/gitweb/?a=blobdiff_plain;f=Documentation%2FCodingGuidelines;h=b8bf618a30fd32a014e41e1ba9914f5e652bdefd;hb=35da43e9bb4a5d7542c2ee27e0a3557ac921e3ab;hp=f628c1f3b7b706f9d585b96041e5a4b12bc0f62c;hpb=a1eb73d917e15cd97314e0a39cbe857329339a96;p=git.git diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index f628c1f3b..b8bf618a3 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -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): @@ -124,3 +129,6 @@ For C programs: used in the git core command set (unless your command is clearly separate from it, such as an importer to convert random-scm-X repositories to git). + + - When we pass pair to functions, we should try to + pass them in that order.