From 5d648d14f5a2dd3ebee354aa029049cdf44a011a Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Wed, 13 Apr 2011 18:14:40 -0400 Subject: hacking guidelines --- HACKING | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 HACKING diff --git a/HACKING b/HACKING new file mode 100644 index 0000000..018f9b7 --- /dev/null +++ b/HACKING @@ -0,0 +1,14 @@ +Where possible, please follow PEP8 with regard to coding style. Sometimes the line +length restriction is too hard to follow, so don't bend over backwards there. + +Triple-quotes should always be """, single quotes are ' unless using " +would result in less escaping within the string. + +All modules, functions, and methods should be well documented reStructuredText for +Sphinx AutoDoc. + +All functionality should be available in pure Python. Optional C (via Cython) +implementations may be written for performance reasons, but should never +replace the Python implementation. + +Lastly, don't take yourself too seriously :) \ No newline at end of file -- cgit v1.2.3-59-g8ed1b