[Twisted-Python] Changelog
we now have a changelog, a log of changes. use the changelog. the changelog is to be used. enter new stuff in the changelog.
Well, this was a surprise to me :-) I just fixed it to actually be in Change Log format. Since we've been back and forth on this issue previously -- changelog vs. commits list vs. "Just use `cvs log`" -- I'm going to offer a suggestion for the use of this file so it doesn't become the sprawling monstrosity that some previous ChangeLogs I've worked on have been. If you're adding a feature, detail it carefully in the ChangeLog and describe it in detail, once. Bugfixes, unless they're sufficiently major to constitute functionality by themselves, shouldn't be described. The ChangeLog should be a high-level, non-technical overview of what is changing, to help users and developers figure out when they need to upgrade. This does *not* mean that anybody should stop writing detailed commit messages to the mailing list. Those should be lower granularity to explain to other developers what each commit is for. On Sun, 2002-01-13 at 07:20, Itamar Shtull-Trauring wrote:
we now have a changelog, a log of changes. use the changelog. the changelog is to be used. enter new stuff in the changelog.
-- ______ you are in a maze of twisted little applications, all | |_\ remarkably consistent. | | -- glyph lefkowitz, glyph @ twisted matrix . com |_____| http://www.twistedmatrix.com/
On Sun, 2002-01-13 at 12:09, Glyph Lefkowitz wrote:
The ChangeLog should be a high-level, non-technical overview of what is changing, to help users and developers figure out when they need to upgrade.
That sounds more like a NEWS file. And we do keep a "What's new in %(version)?" section in the README, but we delete it with every release, which isn't so useful if you skipped a version or two between upgrades. What brought about the ChangeLog was Itamar wondering "What changed in the last three days while the commits list was borked?" which isn't a high-level new-features-only sort of question. That question could be answered by asking CVS, but people have their preferences.
On 13 Jan 2002 12:40:03 -0800, Kevin Turner wrote:
What brought about the ChangeLog was Itamar wondering "What changed in the last three days while the commits list was borked?" which isn't a high-level new-features-only sort of question. That question could be answered by asking CVS, but people have their preferences.
cvs2cl very nicely answers this fine-grained question, for the whole project, w/o having to read an endless "cvs log". Ciao, Jürgen
participants (4)
-
Glyph Lefkowitz -
Itamar Shtull-Trauring -
j.her＠t-online.de -
Kevin Turner