r3439 - Archetypes/branches/release-1_4-branch/docs

Author: tiran
Date: Mon Jan 17 12:18:44 2005
New Revision: 3439

Added:
   Archetypes/branches/release-1_4-branch/docs/CHANGES_AT14.txt   (contents, 
props changed)
   Archetypes/branches/release-1_4-branch/docs/CodingRules.txt   (contents, 
props changed)
Log:
Added CHANGES_AT14.txt which will describe the changes from AT 1.3 to AT 1.4 
and how to migrate your products to AT 1.4
CodingRules describes how to code nicely :)

Added: Archetypes/branches/release-1_4-branch/docs/CHANGES_AT14.txt
==============================================================================
--- (empty file)
+++ Archetypes/branches/release-1_4-branch/docs/CHANGES_AT14.txt        Mon Jan 
17 12:18:44 2005
@@ -0,0 +1,3 @@
+XXX memo list -> nice list
+
+* validation package changes
\ No newline at end of file

Added: Archetypes/branches/release-1_4-branch/docs/CodingRules.txt
==============================================================================
--- (empty file)
+++ Archetypes/branches/release-1_4-branch/docs/CodingRules.txt Mon Jan 17 
12:18:44 2005
@@ -0,0 +1,40 @@
+===========================
+Coding rules for Archetypes
+===========================
+
+---------
+Read this
+---------
+
+http://www.python.org/peps/pep-0008.html
+http://dev.zope.org/Wikis/DevSite/Projects/ComponentArchitecture/ZopePythonNamingConventions
+http://dev.zope.org/Wikis/DevSite/Projects/ComponentArchitecture/ClassesAttributesMethods
+http://dev.zope.org/Wikis/DevSite/Projects/ComponentArchitecture/CodeOptimization
+
+--------
+Overview
+--------
+
+* Write unit tests for new features or bugs
+
+* Don't use the string module - use string methods instead
+
+* Use startswith/endswith instead of slicing
+
+* Use isinstance(egg, str) instead of  type(egg) is StringType
+
+* Use interfaces instead of isinstance() or issubclass() if possible
+
+* Follow the naming convention mentioned in PEP 008 and 
+  ZopePythonNamingConventions
+
+* Don't create strings by adding them - instead use the list.append(str),
+ ''.join(list) trick
+
+* Avoid creating large lists in memory
+
+* Avoid loading lot's of objects from ZODB at once - use objectIds() instead
+  objectValues()
+
+* Avoid waking objects from their ghost state - use the catalog and brains if
+  possible


-------------------------------------------------------
The SF.Net email is sponsored by: Beat the post-holiday blues
Get a FREE limited edition SourceForge.net t-shirt from ThinkGeek.
It's fun and FREE -- well, almost....http://www.thinkgeek.com/sfshirt