deltacloud-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From David Lutterkort <lut...@redhat.com>
Subject Commit messages
Date Fri, 06 Jan 2012 01:36:35 GMT
Hi all,

I just went through a long list of commit messages to write the NEWS for
the next release. There are a few things we need to do to make the
commit log more readable:

      * commit messages must be formatted with lines no longer than 80
        chars
      * try to describe in the message how a user would notice what you
        fixed, not what changes you made in the code; document the why,
        the how is clear enough from the diff
      * if the commit fixes a bug (completely or partially) you must
        include the bug number (JIRA NNN or BZ MMMMMM)
      * clearly attribute patches from non-committers
      * make sure each commit addresses only one issue. Don't be afraid
        of seemingly trivial commits.

So instead of

        Fix handling of VM colors in vSphere driver; color needs to be an array sorted in
descending RGB order

write

        vSphere driver: correctly report VM colors
        
        We used to return the colors array for a VM in the wrong order, leading
        users to believe the VM was less colorful than it really was. Now, VM's
        coming from vSphere shine in full TruColor(tm)
        
        Fixes JIRA 42 [feel free to include full URL]
        
        Signed-off-by: Joe E. Hacker [if their patch doesn't have a Signed-off-by,
        add 'Patch from' or similar]

In short: when writing a commit message, think about how you'd summarize
that commit in the NEWS two months from now.

David



Mime
View raw message