Mailing-List: contact cassandra-dev-help@incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: cassandra-dev@incubator.apache.org
Received-SPF: pass (athena.apache.org: domain of shalinmangar@gmail.com
 designates 209.85.200.172 as permitted sender)
DomainKey-Signature: a=rsa-sha1; c=nofws;
        d=gmail.com; s=gamma;
        h=mime-version:in-reply-to:references:date:message-id:subject:from:to
         :content-type;
        b=vDLqyRWrecKLm3b73oIoAiEvsPZUiBomsdXuhSJiKIR4FfgN2DLxyUr8c2anMHS5xc
         VjdlhojGaR24TpPJ92x+E9nH8oHlBNrb8iKvWrSGy6i0QxjXiIDOFzk9AEjCjtpmApQQ
         EMhmdULQ53D7yEV0nZW071bjmwQVbgyYHTeoA=
MIME-Version: 1.0
In-Reply-To: <6c59d89a0903311119n351d87c8p5d9b3e513c142b10@mail.gmail.com>
References: <87skktsiec.fsf@shaolin.home.digitalvampire.org>
	 <e06563880903311101w705a32b9vf98eb92aa7f0715e@mail.gmail.com>
	 <6c59d89a0903311119n351d87c8p5d9b3e513c142b10@mail.gmail.com>
Date: Sat, 4 Apr 2009 15:50:31 +0530
Message-ID: <69de18140904040320o667b8b7dh473761f08e38113b@mail.gmail.com>
Subject: Re: More verbose svn commit messages would be useful
From: Shalin Shekhar Mangar <shalinmangar@gmail.com>
To: cassandra-dev@incubator.apache.org
Content-Type: multipart/alternative; boundary=000e0cd22f28e1d5db0466b80391

--000e0cd22f28e1d5db0466b80391
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit

On Tue, Mar 31, 2009 at 11:49 PM, Torsten Curdt <tcurdt@apache.org> wrote:

> > But my philosophy in general is that commit messages should be a one
> > sentance summary.  Maybe two.  Gory details should be in jira and the
> > code, if necessary.  The linux kernel may prefer to be more verbose
> > but that is not the only way to do things; I think you will find that
> > smaller projects lean towards being more terse.  I checked a few
> > projects I have checked out locally (sqlalchemy, thrift, hadoop core,
> > and hbase) and all seem to follow "one sentence or two."
>
> One sentence or two is fine ... as long as it captures nature of the
> commit.
>
> More important is to add the name of contributor of the patch (also
> for legal reasons) and it's more than just convenient to provide a
> link to the jira. That is common practice.
>
>
My 2 cents.

I guess if you follow the way commit messages are marked in the Lucene
world, it should be fine. For example:

CASSANDRA-31 -- Clean up misspellings and javadoc warnings

The CHANGES.txt is where all the authors of the contributions are marked.
You can add them to the commit message. But there are usually many people
contributing:
1. The person who reported the issue and/or opened the issue (perhaps only
on the mailing list)
2. The people who contributed patches
3. The people who reviewed the patch
4. The person who committed the code

For an example look at Solr's change log
http://svn.apache.org/repos/asf/lucene/solr/tags/release-1.3.0/CHANGES.txt

-- 
Regards,
Shalin Shekhar Mangar.

--000e0cd22f28e1d5db0466b80391--