Home Explore Help
Sign In
CityApper
/
dulwich
mirror of https://github.com/jelmer/dulwich
2
0
Fork 0
Files Issues 0 Wiki
Branch: disperse-action
Branches Tags
dulwich
/
CONTRIBUTING.rst

CONTRIBUTING.rst 2.0 KB
Permalink History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556 
  1. All functionality should be available in pure Python. Optional Rust
    2. 

  2. implementations may be written for performance reasons, but should never
    3. 

  3. replace the Python implementation.
    4. 

  4. 

  5. Where possible include updates to NEWS along with your improvements.
    6. 

  6. 

  7. New functionality and bug fixes should be accompanied by matching unit tests.
    8. 

  8. 

  9. Coding style
    10. 

  10. ------------
    11. 

  11. Where possible, please follow PEP8 with regard to coding style. Run ruff.
    12. 

  12. 

  13. Furthermore, triple-quotes should always be """, single quotes are ' unless
    14. 

  14. using " would result in less escaping within the string.
    15. 

  15. 

  16. Public methods, functions and classes should all have doc strings. Please use
    17. 

  17. Google style docstrings to document parameters and return values.
    18. 

  18. You can generate the documentation by running "make doc".
    19. 

  19. 

  20. Running the tests
    21. 

  21. -----------------
    22. 

  22. To run the testsuite, you should be able to simply run "make check". This
    23. 

  23. will run the tests using unittest.
    24. 

  24. 

  25. ::
    26. 

  26.    $ make check
    27. 

  27. 

  28. Tox configuration is also present.
    29. 

  29. 

  30. String Types
    31. 

  31. ------------
    32. 

  32. Like Linux, Git treats filenames as arbitrary bytestrings. There is no prescribed
    33. 

  33. encoding for these strings, and although it is fairly common to use UTF-8, any
    34. 

  34. raw byte strings are supported.
    35. 

  35. 

  36. For this reason, the lower levels in Dulwich treat git-based filenames as
    37. 

  37. bytestrings. It is up to the Dulwich API user to encode and decode them if
    38. 

  38. necessary. The porcelain may accept unicode strings and convert them to
    39. 

  39. bytestrings as necessary on the fly (using 'utf-8').
    40. 

  40. 

  41. * on-disk filenames: regular strings, or ideally, pathlib.Path instances
    42. 

  42. * git-repository related filenames: bytes
    43. 

  43. * object sha1 digests (20 bytes long): bytes
    44. 

  44. * object sha1 hexdigests (40 bytes long): str (bytestrings on python2, strings
    45. 

  45.   on python3)
    46. 

  46. 

  47. Merge requests
    48. 

  48. --------------
    49. 

  49. Please either send pull requests to the maintainer (jelmer@jelmer.uk) or create
    50. 

  50. new pull requests on GitHub.
    51. 

  51. 

  52. Licensing
    53. 

  53. ---------
    54. 

  54. All contributions should be made under the same license that Dulwich itself
    55. 

  55. comes under: both Apache License, version 2.0 or later and GNU General Public
    56. 

  56. License, version 2.0 or later.
    57.