Browse Source

Clarify HACKING, add note on unit tests.

Jelmer Vernooij 12 years ago
parent
commit
1691913d09
1 changed files with 9 additions and 7 deletions
  1. 9 7
      HACKING

+ 9 - 7
HACKING

@@ -1,3 +1,12 @@
+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
 Coding style
 ------------
 ------------
 Where possible, please follow PEP8 with regard to coding style.
 Where possible, please follow PEP8 with regard to coding style.
@@ -5,17 +14,10 @@ Where possible, please follow PEP8 with regard to coding style.
 Furthermore, triple-quotes should always be """, single quotes are ' unless
 Furthermore, triple-quotes should always be """, single quotes are ' unless
 using " would result in less escaping within the string.
 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
 Public methods, functions and classes should all have doc strings. Please use
 epydoc style docstrings to document parameters and return values.
 epydoc style docstrings to document parameters and return values.
 You can generate the documentation by running "make doc".
 You can generate the documentation by running "make doc".
 
 
-Where possible please include updates to NEWS along with your improvements.
-
 Running the tests
 Running the tests
 -----------------
 -----------------
 To run the testsuite, you should be able to simply run "make check". This
 To run the testsuite, you should be able to simply run "make check". This