[PATCH] Add commit message guidelines to developer policy

Reid Kleckner rnk at google.com
Tue Mar 10 08:56:48 PDT 2015


REPOSITORY
  rL LLVM

================
Comment at: docs/DeveloperPolicy.rst:294
@@ +293,3 @@
+* The body should be aligned to 80 columns and have as many paragraphs as
+  necessary, but not more than that. Meaning you should be concise, but
+  explanatory, including a complete reasoning, but leaving examples, code
----------------
hfinkel wrote:
> Please don't say this. IMHO, we don't have a problem with commit messages being too long; and small code examples explaining what the commit is addressing can be really informative after the fact. We could say that, if the commit message is long, to please provide a summary paragraph at the top.
> 
Agreed, I think this is a representative good commit message of mine with an example:
    Don't diagnose no-prototype callee-cleanup function definitions

    We already have a warning on the call sites of code like this:
      void f() { }
      void g() { f(1, 2, 3); }
    t.c:2:21: warning: too many arguments in call to 'f'

    We can limit ourselves to diagnosing unprototyped forward declarations
    of f to cut down on noise.

http://reviews.llvm.org/D8197

EMAIL PREFERENCES
  http://reviews.llvm.org/settings/panel/emailpreferences/






More information about the cfe-commits mailing list