Re: A word about Mercurial commit messages

I notice the CPython devguide -- therefore the future Jython devguide(!) 
-- has similar advice 
(https://devguide.python.org/committing#commit-messages) to Frank's 
recommendation below: pithy one-liner, blank line, complete brief 
information.

It refrains from specifying actual line lengths, but 72 has been working 
for me. (Never sure whether to line-break paragraph #2+ manually.)

And GitHub is unforgiving after 72: 
https://github.com/jython/jython3/commit/5b4dc2d54d01a6fda8c55d07b2608167e7a40769, 
so I guess we'll have to fit in.

Jeff


On 12/09/2014 07:21, Jeff Allen wrote:
> I'm happy to follow Frank. Scrolling back down Hg Workbench I see that 
> (lately) he, Indra and Santoso to varying degrees follow the 
> recommended convention. (I'm not sure I can stick to 50 for the 
> summary!) Hg Workbench gives me a settable red line, by default at 
> column 80 (but 72 if we follow the blog). I seem to have wrap and EOL 
> options, but they don't stick :(.
>
> Jeff
> Jeff Allen
> On 11/09/2014 23:47, Jim Baker wrote:
>>
>> +1, as a frequent violator myself. I plan to reform my ways ;), since 
>> this makes a lot of sense for seeing the summaries in the abstract, 
>> vs say just reviewing hg log.
>>
>>
>> -- 
>> - Jim
>> Jim Baker
>>
>>
>> On September 11, 2014 at 3:44:06 PM, [email protected] 
>> ([email protected] <mailto:[email protected]>) wrote:
>>
>>> On Thu, Sep 11, 2014 at 1:23 PM, Jeff Allen <[email protected]> wrote:
>>> > Mercurial will use your commit message up to the first line break 
>>> as the
>>> > abstract it displays, for example here: http://hg.python.org/jython/
>>> > Worth thinking about how that will read. I don't think we have an 
>>> actual
>>> > rule about length.
>>> Although I don't always practice it, I like the guideline that I've
>>> seen in git circles detailed here:
>>> http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
>>>
>>> The important part being a 50 char or less first line separated by a
>>> blank line, followed by the detailed message if necessary.
>>>
>>> -Frank
>>>
>

------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot

_______________________________________________
Jython-dev mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/jython-dev