"Fixed bug #XYZZY"

"Fixed bug #XYZZY"

[Eli Zaretskii]

Can we agree to say something in the commit log's summary line about
the bug essence, in addition to the bug number?  Otherwise, the
summary is not really informative, and you need to look at the bug
report in the tracker.

Re: "Fixed bug #XYZZY"

[Bozhidar Batsov]

[-- Attachment #1: Type: text/plain, Size: 532 bytes --]

I’d suggest adopting the common convention

[Fix #XYZ] Short and informative summary

Makes it easier to visually parse the line and tools like magit-commit-mode font-lock this nicely.

—
Cheers, 
Bozhidar

On December 8, 2014 at 7:18:01 PM, Eli Zaretskii (eliz@gnu.org) wrote:

Can we agree to say something in the commit log's summary line about  
the bug essence, in addition to the bug number? Otherwise, the  
summary is not really informative, and you need to look at the bug  
report in the tracker.  


[-- Attachment #2: Type: text/html, Size: 1898 bytes --]

Re: "Fixed bug #XYZZY"

[Eli Zaretskii]

> Date: Mon, 8 Dec 2014 19:30:11 +0200
> From: Bozhidar Batsov <bozhidar.batsov@gmail.com>
> 
> I’d suggest adopting the common convention
> 
> [Fix #XYZ] Short and informative summary

I obviously agree (and am doing almost literally that for some time).

Re: "Fixed bug #XYZZY"

[Stefan Monnier]

> Can we agree to say something in the commit log's summary line about
> the bug essence, in addition to the bug number?  Otherwise, the
> summary is not really informative, and you need to look at the bug
> report in the tracker.

Indeed, the bug number should be on another line.  The summary should
describe the change, instead.  Of course, if they both fit, it's OK to
put them together.  Also remember to use the "bug#NNN" format.


        Stefan

Re: "Fixed bug #XYZZY"

[Eli Zaretskii]

> From: Stefan Monnier <monnier@iro.umontreal.ca>
> Date: Mon, 08 Dec 2014 13:33:14 -0500
> Cc: emacs-devel@gnu.org
> 
> > Can we agree to say something in the commit log's summary line about
> > the bug essence, in addition to the bug number?  Otherwise, the
> > summary is not really informative, and you need to look at the bug
> > report in the tracker.
> 
> Indeed, the bug number should be on another line.  The summary should
> describe the change, instead.  Of course, if they both fit, it's OK to
> put them together.  Also remember to use the "bug#NNN" format.

So, can we codify something like this:

   Summary bla-bla summary line.

   Fixes: bug#NNNNN

   * src/foobar.c (foobar): Change.
   * lisp/foobar.el (foo-bar): Change.

?

Re: "Fixed bug #XYZZY"

[Stefan Monnier]

> So, can we codify something like this:

>    Summary bla-bla summary line.

>    Fixes: bug#NNNNN

Sounds good.  I'm also OK with a "(bug#NNN)" somewhere at some end
of line.


        Stefan

Re: "Fixed bug #XYZZY"

[Werner LEMBERG]

>> I’d suggest adopting the common convention
>> 
>> [Fix #XYZ] Short and informative summary
> 
> I obviously agree (and am doing almost literally that for some
> time).

If you say

  Fix XYZ:

you can have two more characters for the description.


    Werner

Re: "Fixed bug #XYZZY"

[Stephen Leake]

Stefan Monnier <monnier@iro.umontreal.ca> writes:

>> So, can we codify something like this:
>
>>    Summary bla-bla summary line.
>
>>    Fixes: bug#NNNNN
>
> Sounds good.  

Added to CONFIGURE

-- 
-- Stephe

Re: "Fixed bug #XYZZY"

[Stephen Leake]

Stephen Leake <stephen_leake@stephe-leake.org> writes:

> Stefan Monnier <monnier@iro.umontreal.ca> writes:
>
>>> So, can we codify something like this:
>>
>>>    Summary bla-bla summary line.
>>
>>>    Fixes: bug#NNNNN
>>
>> Sounds good.  
>
> Added to CONFIGURE
           ^^^^^^^^^
           
arg; too late at night. That's CONTRIBUTE.

-- 
-- Stephe