Acasă Explorează Ajutor
Autentificare
CityApper
/
dulwich
oglindă de https://github.com/jelmer/dulwich
2
0
Bifurcare 0
Fisiere Probleme 0 Wiki
Ramură: config-closing-bracket
Ramuri Etichete
dulwich
/
CONTRIBUTING.rst

CONTRIBUTING.rst 2.1 KB
Permalink Istoric Crud

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657 
  1. All functionality should be available in pure Python. Optional C
    2. 

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

  3. replace the Python implementation. The C implementations should follow the
    4. 

  4. kernel/git coding style.
    5. 

  5. 

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

  7. 

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

  9. 

  10. Coding style
    11. 

  11. ------------
    12. 

  12. Where possible, please follow PEP8 with regard to coding style.
    13. 

  13. 

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

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

  16. 

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

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

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

  20. 

  21. Running the tests
    22. 

  22. -----------------
    23. 

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

  24. will run the tests using unittest.
    25. 

  25. 

  26. ::
    27. 

  27.    $ make check
    28. 

  28. 

  29. Tox configuration is also present as well as a Travis configuration file.
    30. 

  30. 

  31. String Types
    32. 

  32. ------------
    33. 

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

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

  35. raw byte strings are supported.
    36. 

  36. 

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

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

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

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

  41. 

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

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

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

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

  46.   on python3)
    47. 

  47. 

  48. Merge requests
    49. 

  49. --------------
    50. 

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

  51. new pull requests on GitHub.
    52. 

  52. 

  53. Licensing
    54. 

  54. ---------
    55. 

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

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

  57. License, version 2.0 or later.
    58.