[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Updated HACKING
From: |
Ludovic Courtès |
Subject: |
Re: Updated HACKING |
Date: |
Thu, 04 Sep 2008 21:49:42 +0200 |
User-agent: |
Gnus/5.11 (Gnus v5.11) Emacs/22.2 (gnu/linux) |
Hi,
Andy Wingo <address@hidden> writes:
> On Wed 03 Sep 2008 19:35, Han-Wen Nienhuys <address@hidden> writes:
>
>> How about the following:
>>
>>
>> - Provide a description in the commit message, like so:
>>
>> 1-line description of change
>>
>> More extensive discussion of your change. Document why you are
>> changing things.
>>
>> * filename (function name): file specific change comments.
>
> This looks really good to me. If we move from ChangeLogs, then it makes
> sense to adjust the format as necessary, preserving the same semantics.
> We should probably propose this as the standard GNU format, actually. (I
> believe bzr people use something like this as well.)
Actually, what you're proposing is what I had in mind. :-)
It's essentially the GNU ChangeLog format, with the addition of the
summary line and optional extended summary. Adding a one-line summary
has been common practice in some projects, there are examples in Gnulib
and Guile.
Anyway, if you are willing to propose something beyond just that, the
discussion should be directed to `gnu-prog-discuss' IMO.
Thanks,
Ludo'.
- Updated HACKING, Han-Wen Nienhuys, 2008/09/03
- Re: Updated HACKING, Ludovic Courtès, 2008/09/03
- Re: Updated HACKING, Han-Wen Nienhuys, 2008/09/03
- Re: Updated HACKING, Ludovic Courtès, 2008/09/04
- Re: Updated HACKING, Andy Wingo, 2008/09/04
- Re: Updated HACKING,
Ludovic Courtès <=
- Re: Updated HACKING, Neil Jerram, 2008/09/11
- Re: Updated HACKING, Ludovic Courtès, 2008/09/12
- `ChangeLog' files are gone!, Ludovic Courtès, 2008/09/12
- Re: `ChangeLog' files are gone!, Neil Jerram, 2008/09/14