Re: [Zope-dev] Changelog formatting [was: SVN: cmf.pt/trunk/ Preparing release.]

2008-12-24 Thread Malthe Borch 
2008/12/21 Philipp von Weitershausen phil...@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
 (-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
___
Zope-Dev maillist  -  Zope-Dev@zope.org
http://mail.zope.org/mailman/listinfo/zope-dev
**  No cross posts or HTML encoding!  **
(Related lists - 
 http://mail.zope.org/mailman/listinfo/zope-announce
 http://mail.zope.org/mailman/listinfo/zope )

[Zope-dev] Changelog formatting [was: SVN: cmf.pt/trunk/ Preparing release.]

2008-12-21 Thread Philipp von Weitershausen 
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 (-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-software.txt
[2] 
http://svn.zope.org/*checkout*/Sandbox/philikon/foundation/releasing-software.txt
[3] http://grok.zope.org/documentation/how-to/releasing-software
___
Zope-Dev maillist  -  Zope-Dev@zope.org
http://mail.zope.org/mailman/listinfo/zope-dev
**  No cross posts or HTML encoding!  **
(Related lists - 
 http://mail.zope.org/mailman/listinfo/zope-announce
 http://mail.zope.org/mailman/listinfo/zope )