CONTRIBUTING

   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 by 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
  28
  29 String Types
  30 ------------
  31 Like Linux, Git treats filenames as arbitrary bytestrings. There is no prescribed
  32 encoding for these strings, and although it is fairly common to use UTF-8, any
  33 raw byte strings are supported.
  34
  35 For this reason, Dulwich internally treats git-based filenames as bytestrings. It is up
  36 to the Dulwich API user to encode and decode them if necessary.
  37
  38 * git-repository related filenames: bytes
  39 * object sha1 digests (20 bytes long): bytes
  40 * object sha1 hexdigests (40 bytes long): str (bytestrings on python2, strings on python3)
  41
  42 Merge requests
  43 --------------
  44 Please either send pull requests to the author (jelmer@jelmer.uk) or create new pull
  45 requests on GitHub.
  46
  47 Licensing
  48 ---------
  49 Dulwich is currently licensed under the GNU General Public License, version 2
  50 or later. We would like to change the license to Apachev2 or later eventually;
  51 new contributions should be made under dual GPLv2+/Apachev2+.