You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@sis.apache.org by Martin Desruisseaux <ma...@geomatys.fr> on 2014/04/01 06:57:29 UTC

What should we do with the CHANGES file?

Hello all

I'm in the process of preparing a release candidate and got a question.
The root of Apache SIS contains a file named "CHANGES". At first, this
file was apparently updated everytime a commit was done, together with a
corresponding JIRA task. But this discipline has not really be followed
lately. What should we do with this file? Alternatives I can see are:

 1. Leave it unchanged, but it would be misleading for those who may
    read it since it doesn't list the changes applied in the last 18 months.
 2. Copy the SVN logs to that file, but that would be very verbose.
 3. Copy the list of JIRA tasks to that file, but that would duplicate
    the release notes [1].
 4. Consider the file as unmaintained, and consequently remove it. It
    would still be present in all branches/ and tags/ directories prior 0.4.


What do peoples think?

    Martin

[1] http://sis.staging.apache.org/release-notes/0.4.html


Re: What should we do with the CHANGES file?

Posted by "Mattmann, Chris A (3980)" <ch...@jpl.nasa.gov>.
+1 to remove it..

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Chris Mattmann, Ph.D.
Chief Architect
Instrument Software and Science Data Systems Section (398)
NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
Office: 168-519, Mailstop: 168-5th floor
Email: chris.a.mattmann@nasa.gov
WWW:  http://sunset.usc.edu/~mattmann/
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Adjunct Associate Professor, Computer Science Department
University of Southern California, Los Angeles, CA 90089 USA
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++






-----Original Message-----
From: Martin Desruisseaux <ma...@geomatys.fr>
Organization: Geomatys
Reply-To: "dev@sis.apache.org" <de...@sis.apache.org>
Date: Monday, March 31, 2014 9:57 PM
To: Apache SIS <de...@sis.apache.org>
Subject: What should we do with the CHANGES file?

>Hello all
>
>I'm in the process of preparing a release candidate and got a question.
>The root of Apache SIS contains a file named "CHANGES". At first, this
>file was apparently updated everytime a commit was done, together with a
>corresponding JIRA task. But this discipline has not really be followed
>lately. What should we do with this file? Alternatives I can see are:
>
> 1. Leave it unchanged, but it would be misleading for those who may
>    read it since it doesn't list the changes applied in the last 18
>months.
> 2. Copy the SVN logs to that file, but that would be very verbose.
> 3. Copy the list of JIRA tasks to that file, but that would duplicate
>    the release notes [1].
> 4. Consider the file as unmaintained, and consequently remove it. It
>    would still be present in all branches/ and tags/ directories prior
>0.4.
>
>
>What do peoples think?
>
>    Martin
>
>[1] http://sis.staging.apache.org/release-notes/0.4.html
>