Arash Esbati <[email protected]> writes:

>> Thanks.  I briefly had a look at other ELPA packages and it seems
>> there is a variety of options: ASCII files, markdown, org files.  So
>> we could install a new file CHANGES.org and use that.
>
> I did some more research on this and like to make this suggestion: We
> should add a file called 'CHANGELOG.org' to our repo and mention our
> changes there.  I suggest to follow the conventions from 'keep a
> changelog'[1]; I think this is a good solution for end users.  I'm
> attaching my first 5 minutes draft on this.
> Any comments welcome.

It's basically a fineer-grained version of changes.texi, right?  So
basically we could write CHANGELOG.org and summarize that in
changes.texi before a tarball release.

Well, but then the changes in the manual would be incomplete in the ELPA
releases.  So we might as well start documenting changes
micro-version-wise in changes.texi and then use the generated CHANGES
text file for ELPA¹.  That would omit duplication.

Bye,
Tassilo

¹ This assumes that we start to do ELPA releases from the master branch
  where our normal build procedure is performed to produce the ELPA
  release tarball.  I haven't had the time to bring that topic up in a
  separate thread but will do so ASAP.

Reply via email to