lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Grant Ingersoll <gsing...@apache.org>
Subject Re: Changes Mess
Date Mon, 06 Dec 2010 15:42:21 GMT

On Dec 5, 2010, at 12:18 PM, Robert Muir wrote:

> On Sun, Dec 5, 2010 at 12:08 PM, Mattmann, Chris A (388J)
> <chris.a.mattmann@jpl.nasa.gov> wrote:
>> Hi Mark,
>> 
>> RE: the credit system. JIRA provides a contribution report here, like this one that
I generated for Lucene 3.1:
>> 
> 
> My concern with this is that it leaves out important email contributors.

I think we probably miss these as is too.

<br/>

Note, however, in my proposal, one can still call out specific things.  We could for instance
have a "Contributors" section and just add names to it.  I just think we put too much minutiae
in CHANGES and it is a real burden to deal with it across branches b/c there are always massive
conflicts and it requires you to look up every last change to recall which version it is in.
  IMO, JIRA should be the system of record for all bug discussions.  Discussions that happen
on email can easily be pointed to using any one of our many mail archive systems.

Our new Changes could be structured like below.  The important thing about this approach is
that it can all more or less be written at release time other than the contributor list and
perhaps the back compat section.

</snip>
= Version X.Y  =

Brief Intro

== Dependencies ==
Junit 4.4

== New Features ==

* Magic search was implemented

== Backward Compatibility Breaks ==

* Blah, blah, blah

== Significant Changes ==

* We've replaced the inverted index with a giant array

== Contributors ==
(alphabetical order)
Joe Schmoe (optionally cite an issue number)
Jane Doe

Optionally paste in the list from JIRA

== Full Changes List ==

* LINK TO JIRA
</snip>


-Grant
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


Mime
View raw message