HACKING

   1 All functionality should be available in pure Python. Optional C
   2 implementations may be written for performance reasons, but should never
   3 replace the Python implementation. The C implementations should follow the
   4 kernel/git coding style.
   5
   6 Where possible include updates to NEWS along with your improvements.
   7
   8 New functionality and bug fixes should be accompanied with matching unit tests.
   9
  10 Coding style
  11 ------------
  12 Where possible, please follow PEP8 with regard to coding style.
  13
  14 Furthermore, triple-quotes should always be """, single quotes are ' unless
  15 using " would result in less escaping within the string.
  16
  17 Public methods, functions and classes should all have doc strings. Please use
  18 epydoc style docstrings to document parameters and return values.
  19 You can generate the documentation by running "make doc".
  20
  21 Running the tests
  22 -----------------
  23 To run the testsuite, you should be able to simply run "make check". This
  24 will run the tests using unittest on Python 2.7 and higher, and using
  25 unittest2 (which you will need to have installed) on older versions of Python.
  26
  27  $ make check