On 6 March 2015 at 20:59, Reid Kleckner <rnk at google.com> wrote:> I think the only guideline we should have is that the first line should be > written as though it is an email subject, because it gets used for that. If > you write a long first line, then you get a long subject, and it looks > silly. If people want to embarrass themselves with strangely formatted > email, they it's on them. We don't need a specific hard or soft number.Not many people care about the email subject already, that's why they keep using ridiculously long first lines. IMO, "suggesting" to write short first lines is the same as not doing anything. Either we add a cap (say, 80 chars), or we don't do anything. Chandler's other suggestion, tough, is interesting: to write up a bit about what a *good* message would be, so the people that were really interested, could do it "right" (tm). cheers, --renato
On Fri, Mar 6, 2015 at 1:12 PM, Renato Golin <renato.golin at linaro.org> wrote:> On 6 March 2015 at 20:59, Reid Kleckner <rnk at google.com> wrote: >> I think the only guideline we should have is that the first line should be >> written as though it is an email subject, because it gets used for that. If >> you write a long first line, then you get a long subject, and it looks >> silly. If people want to embarrass themselves with strangely formatted >> email, they it's on them. We don't need a specific hard or soft number. > > Not many people care about the email subject already, that's why they > keep using ridiculously long first lines. > > IMO, "suggesting" to write short first lines is the same as not doing > anything. Either we add a cap (say, 80 chars), or we don't do > anything. > > Chandler's other suggestion, tough, is interesting: to write up a bit > about what a *good* message would be, so the people that were really > interested, could do it "right" (tm). >Another guideline I would like to propose for commit messages is that of attaching to the commit a link to the code review, if any. For big changes, this allows easily to reconstruct the history of the commit, together with other informations (e.g. the reviewers). A potential downside of it is that links might be not valid anymore after a while, but I still think the advantages overcome the problems. FWIW, I already try to include this info when I commit, so if it's not OK or people have concerns about it, I would like to have this explictly stated. -- Davide "There are no solved problems; there are only problems that are more or less solved" -- Henri Poincare
> On Mar 6, 2015, at 1:36 PM, Davide Italiano <davide at freebsd.org> wrote: > > On Fri, Mar 6, 2015 at 1:12 PM, Renato Golin <renato.golin at linaro.org> wrote: >> On 6 March 2015 at 20:59, Reid Kleckner <rnk at google.com> wrote: >>> I think the only guideline we should have is that the first line should be >>> written as though it is an email subject, because it gets used for that. If >>> you write a long first line, then you get a long subject, and it looks >>> silly. If people want to embarrass themselves with strangely formatted >>> email, they it's on them. We don't need a specific hard or soft number. >> >> Not many people care about the email subject already, that's why they >> keep using ridiculously long first lines. >> >> IMO, "suggesting" to write short first lines is the same as not doing >> anything. Either we add a cap (say, 80 chars), or we don't do >> anything. >> >> Chandler's other suggestion, tough, is interesting: to write up a bit >> about what a *good* message would be, so the people that were really >> interested, could do it "right" (tm). >> > > Another guideline I would like to propose for commit messages is that > of attaching to the commit a link to the code review, if any.I believe it is documented here: http://llvm.org/docs/Phabricator.html#committing-a-change Mehdi> For big > changes, this allows easily to reconstruct the history of the commit, > together with other informations (e.g. the reviewers). A potential > downside of it is that links might be not valid anymore after a while, > but I still think the advantages overcome the problems. > > FWIW, I already try to include this info when I commit, so if it's not > OK or people have concerns about it, I would like to have this > explictly stated. > > -- > Davide > > "There are no solved problems; there are only problems that are more > or less solved" -- Henri Poincare > _______________________________________________ > LLVM Developers mailing list > LLVMdev at cs.uiuc.edu http://llvm.cs.uiuc.edu > http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
> -----Original Message----- > From: cfe-dev-bounces at cs.uiuc.edu [mailto:cfe-dev-bounces at cs.uiuc.edu] On > Behalf Of Renato Golin > Sent: Friday, March 06, 2015 1:13 PM > To: Reid Kleckner > Cc: Clang Dev; LLVM Dev > Subject: Re: [cfe-dev] [LLVMdev] Commit message policy? > > On 6 March 2015 at 20:59, Reid Kleckner <rnk at google.com> wrote: > > I think the only guideline we should have is that the first line should > be > > written as though it is an email subject, because it gets used for that. > If > > you write a long first line, then you get a long subject, and it looks > > silly. If people want to embarrass themselves with strangely formatted > > email, they it's on them. We don't need a specific hard or soft number. > > Not many people care about the email subject already, that's why they > keep using ridiculously long first lines. > > IMO, "suggesting" to write short first lines is the same as not doing > anything. Either we add a cap (say, 80 chars), or we don't do > anything. > > Chandler's other suggestion, tough, is interesting: to write up a bit > about what a *good* message would be, so the people that were really > interested, could do it "right" (tm).Renato, Let me reflect this back to you, to make sure I understood it: You don't like the idea of "suggesting" how to write a good message, but you're okay with describing what a good message looks like? (as long as we don't suggest that people should actually write them that way.) --paulr> > cheers, > --renato > _______________________________________________ > cfe-dev mailing list > cfe-dev at cs.uiuc.edu > http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev
On 7 Mar 2015 00:07, "Robinson, Paul" <Paul_Robinson at playstation.sony.com> wrote:> You don't like the idea of "suggesting" how to write a good message, > but you're okay with describing what a good message looks like? (as long > as we don't suggest that people should actually write them that way.)I think merely suggesting will not stop people that don't care from writing bad commit messages, but will help those who do care. I also appreciate that enforcing standards on such petty things can go a long way of making people less welcomed to our community. After all, rules are meant to be broken, metrics are meant to be worked around, and too many rules are meant to make people unhappy. Cheers, Renato -------------- next part -------------- An HTML attachment was scrubbed... URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20150307/04cc49cc/attachment.html>