Changelog formatting [was: SVN: cmf.pt/trunk/ Preparing release.]
Malthe Borch wrote:
Log message for revision 94141: Preparing release.
Changed: U cmf.pt/trunk/CHANGES.txt U cmf.pt/trunk/setup.py
-=- Modified: cmf.pt/trunk/CHANGES.txt =================================================================== --- cmf.pt/trunk/CHANGES.txt 2008-12-17 11:44:23 UTC (rev 94140) +++ cmf.pt/trunk/CHANGES.txt 2008-12-17 12:52:37 UTC (rev 94141) @@ -1,7 +1,7 @@ Changelog =========
-In next release +cmf.pt 0.2 (released 12/17/2008)
I've noticed you're using the U.S. date format here which we discourage due to its ambiguity (in this case it happens not to be ambiguous, but that's just coincidence). The preferred format is the ISO 8601 dash notation (YYYY-MM-DD). This and other things, such as the proper formatting of changelogs, are documented in a guide called "Maintaining Software in the Zope Software Repository" [1] of which "Releasing Software" [2] is a chapter. I admit they're not in the most public place, I'm just the guy who wrote them (by codifying best practices). Anybody who'd like to put them somewhere more visible is most welcome to (e.g. the Grok folks have put the Releasing Software document on their website [3]). Happy holidays everyone, Philipp [1] http://svn.zope.org/*checkout*/Sandbox/philikon/foundation/maintaining-softw... [2] http://svn.zope.org/*checkout*/Sandbox/philikon/foundation/releasing-softwar... [3] http://grok.zope.org/documentation/how-to/releasing-software
2008/12/21 Philipp von Weitershausen <philipp@weitershausen.de>:
I've noticed you're using the U.S. date format here which we discourage due to its ambiguity (in this case it happens not to be ambiguous, but that's just coincidence). The preferred format is the ISO 8601 dash notation (YYYY-MM-DD).
Gotcha. I'll use this format in the future.
This and other things, such as the proper formatting of changelogs, are documented in a guide called "Maintaining Software in the Zope Software Repository" [1] of which "Releasing Software" [2] is a chapter. I admit they're not in the most public place, I'm just the guy who wrote them (by codifying best practices). Anybody who'd like to put them somewhere more visible is most welcome to (e.g. the Grok folks have put the Releasing Software document on their website [3]).
I should review this material. I'm having some problems these days formatting my changelogs. \malthe
participants (2)
-
Malthe Borch -
Philipp von Weitershausen