On commit messages... again

[Jonas Smedegaard]

On Sat, Jan 08, 2011 at 03:04:55PM +0100, IOhannes m zmölnig wrote:
>On 01/08/2011 01:05 AM, Felipe Sateler wrote:
>> Please, be descriptive in the commit messages. A commit message 
>> saying "add libblah-dev as build-depends" is not really useful, as we 
>> can see that from the patch. The point of commit messages is to 
>> explain why the changes are necessary (eg, "Enable support for doing 
>> something, needs libblah").
>
>hmm, 2 remarks on that:
>- - given that git-dch _could_ be used to generate the changelog i would
>recommend to put the description you want to see in debian/changelog as
>the "title" (1st line) of the patch
>
>- - everything else (e.g why you think it is good and necessary to do what
>you have done, what you think might be done once there is time and why
>and everything) ought to be in the "body" (line3-EOF (with line2 being
>empty)) of the commit message

As a minimum, I agree.

Preferrably, though, even the first line (i.e. the changelog entry) 
include tiny explanation too IMO.

...and while at it, I prefer writing in present tense (not past tense) 
due to often being slightly shorter and equally appropriate IMO.


  - Jonas

-- 
  * Jonas Smedegaard - idealist & Internet-arkitekt
  * Tlf.: +45 40843136  Website: http://dr.jones.dk/

  [x] quote me freely  [ ] ask before reusing  [ ] keep private
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 836 bytes
Desc: Digital signature
URL: <http://lists.alioth.debian.org/pipermail/pkg-multimedia-maintainers/attachments/20110108/ec3078cd/attachment.pgp>