Coding Standards for praksys plone products
Coding Standards for praksys plone products.
General
- English language is preferred
- Text files (README, docs...) should be StructuredText see An Introduction to Structured Text
uml / python names
- classes are CamelCase
- Ticket, TicketAccount, Computer, ALongNamedClass
- attributes and variable are lower_case
- an_attribute, id, a_long_named_attribute, my_loop_variable
- objects are camelCase
- myLoopVariable, aTicketAccount, aLongNamedObject
CVS/BZR commit rule
- one line per change :
- prefixed with
*for a modification - prefixed with
+for an addition (withoutaddedin message) - prefixed with
-for a removal (withoutremovedin message)
- prefixed with
- example of a commit log :
* fixed nasty bug - unused 'test.py' + 'NewClass.py'
