Permalink
Browse files

Clarify HACKING, add note on unit tests.

  • Loading branch information...
jelmer committed May 4, 2013
1 parent c8e705a commit b5a450148b319ab7eb4979e515c29d27a9ae064e
Showing with 9 additions and 7 deletions.
  1. +9 −7 HACKING
View
16 HACKING
@@ -1,21 +1,23 @@
+All functionality should be available in pure Python. Optional C
+implementations may be written for performance reasons, but should never
+replace the Python implementation. The C implementations should follow the
+kernel/git coding style.
+
+Where possible include updates to NEWS along with your improvements.
+
+New functionality and bug fixes should be accompanied with matching unit tests.
+
Coding style
------------
Where possible, please follow PEP8 with regard to coding style.
Furthermore, triple-quotes should always be """, single quotes are ' unless
using " would result in less escaping within the string.
-All functionality should be available in pure Python. Optional C
-implementations may be written for performance reasons, but should never
-replace the Python implementation. The C implementations should follow the
-kernel/git coding style.
-
Public methods, functions and classes should all have doc strings. Please use
epydoc style docstrings to document parameters and return values.
You can generate the documentation by running "make doc".
-Where possible please include updates to NEWS along with your improvements.
-
Running the tests
-----------------
To run the testsuite, you should be able to simply run "make check". This

0 comments on commit b5a4501

Please sign in to comment.