This commit is contained in:
Brian Waldon 2011-07-29 12:49:48 -04:00
parent f9ccecca6f
commit 740d273cf8

30
HACKING
View File

@ -5,13 +5,23 @@ Step 1: Read http://www.python.org/dev/peps/pep-0008/
Step 2: Read http://www.python.org/dev/peps/pep-0008/ again
Step 3: Read on
General
-------
- Put two newlines twixt toplevel code (funcs, classes, etc)
- Put one newline twixt methods in classes and anywhere else
- Do not write "except:", use "except Exception:" at the very least
- Include your name with TODOs as in "TODO(termie)"
- Do not name anything the same name as a builtin or reserved word
Imports
-------
- thou shalt not import objects, only modules
- thou shalt not import more than one module per line
- thou shalt not make relative imports
- thou shalt order your imports by the full module path
- thou shalt organize your imports according to the following template
- Do not import objects, only modules
- Do not import more than one module per line
- Do not make relative imports
- Order your imports by the full module path
- Organize your imports according to the following template
::
# vim: tabstop=4 shiftwidth=4 softtabstop=4
@ -23,16 +33,6 @@ Imports
{{begin your code}}
General
-------
- thou shalt put two newlines twixt toplevel code (funcs, classes, etc)
- thou shalt put one newline twixt methods in classes and anywhere else
- thou shalt not write "except:", use "except Exception:" at the very least
- thou shalt include your name with TODOs as in "TODO(termie)"
- thou shalt not name anything the same name as a builtin or reserved word
- thou shalt not violate causality in our time cone, or else
Human Alphabetical Order Examples
---------------------------------
::