Hi, I haven't got any comments to add that haven't already been discussed but I thought it would be worth mentioning that Phabricator's documentation has a fairly good section on good commit messages at https://secure.phabricator.com/book/phabflavor/article/writing_reviewable_code/#write-sensible-commit-me.> -----Original Message----- > From: cfe-dev-bounces at cs.uiuc.edu [mailto:cfe-dev-bounces at cs.uiuc.edu] > On Behalf Of Renato Golin > Sent: 25 September 2014 17:15 > To: Reid Kleckner > Cc: Clang Dev; LLVM Dev > Subject: Re: [cfe-dev] [LLVMdev] Commit message policy? > > On 25 September 2014 16:52, Reid Kleckner <rnk at google.com> wrote: > > That seems mostly reasonable. I'd try to make it more concise, though. The > > coding standards and developer policy docs should be short. > > Right, version 2 attached. Does everyone agree with it? > > cheers, > --renato
On 26 September 2014 11:12, Daniel Sanders <Daniel.Sanders at imgtec.com> wrote:> I haven't got any comments to add that haven't already been discussed but I thought it would be worth mentioning that Phabricator's documentation has a fairly good section on good commit messages at https://secure.phabricator.com/book/phabflavor/article/writing_reviewable_code/#write-sensible-commit-me.Those are good content guidelines... My point was more to the format (which I do find important), and I think we should *also* encourage some syntax in addition to semantics. It makes more sense for Differential to not care about those stuff (since it's project-specific) that for any project that uses Differential. I think we should have both guidelines, content and syntax, but not enforce or codify them. We could reuse that content, but not link directly, as we can never tell when that page changes and our assumptions may not change in the same direction. cheers, --renato
I agree that some unenforced syntax guidance is helpful. The first line length one should be particularly useful for me when I'm using Outlook Web Access which cuts off the subject line at 32 characters.> -----Original Message----- > From: Renato Golin [mailto:renato.golin at linaro.org] > Sent: 26 September 2014 11:21 > To: Daniel Sanders > Cc: Reid Kleckner; Clang Dev; LLVM Dev > Subject: Re: [cfe-dev] [LLVMdev] Commit message policy? > > On 26 September 2014 11:12, Daniel Sanders <Daniel.Sanders at imgtec.com> > wrote: > > I haven't got any comments to add that haven't already been discussed but > I thought it would be worth mentioning that Phabricator's documentation > has a fairly good section on good commit messages at > https://secure.phabricator.com/book/phabflavor/article/writing_reviewable > _code/#write-sensible-commit-me. > > Those are good content guidelines... > > My point was more to the format (which I do find important), and I > think we should *also* encourage some syntax in addition to semantics. > It makes more sense for Differential to not care about those stuff > (since it's project-specific) that for any project that uses > Differential. > > I think we should have both guidelines, content and syntax, but not > enforce or codify them. > > We could reuse that content, but not link directly, as we can never > tell when that page changes and our assumptions may not change in the > same direction. > > cheers, > --renato