[liblouis-liblouisxml] ChangeLog file
- From: James Teh <jamie@xxxxxxxxxxx>
- To: liblouis/liblouisxml mailing list <liblouis-liblouisxml@xxxxxxxxxxxxx>
- Date: Thu, 22 Jan 2009 21:58:27 +1000
Hi all,
I brought this up on IRC yesterday, but thought I'd post it here for all
to see.
How do people feel about dropping the ChangeLog file? My reasons for
this proposal:
* We should be specifying detailed commit log messages for each commit.
These can be easily retrieved and also allow you to track down the
reason for a given piece of code with svn blame.
* Adding these messages to the ChangeLog as well is redundant and thus
an extra, unnecessary step.
* Having a file for this info suggests that it might be useful to its
users. However, if a change is made and then later reverted before
release, this is confusing to users.
* The ChangeLog format requires that the date be included for each
entry. However, it is unclear as to how overlapping changes by multiple
users should be handled. svn already provides timestamps on its commits
which are far more accurate.
* The ChangeLog format requires that all changed files be specified, but
this can already be retrieved from svn.
This proposal would require the following:
* Commit messages would need to be as detailed as possible. The commit
messages act as the detailed ChangeLog.
* User visible changes would need to be added to the NEWS file as they
were made. This is the file that tells users about the noteworthy
changes in a new release.
* Any user visible changes that are reverted before release can be
removed from the NEWS file.
Of course, this is entirely my opinion and I don't expect everyone else
to agree. I will keep updating the ChangeLog if John or anyone else
would prefer to keep it. :)
--
James Teh
Email/MSN Messenger/Jabber: jamie@xxxxxxxxxxx
Web site: http://www.jantrid.net/
For a description of the software and to download it go to
http://www.jjb-software.com
Other related posts:
