| Laurens Van Houtven | 5a42298 | 2014-03-15 21:42:31 +0100 | [diff] [blame] | 1 | Contributing |
| 2 | ============ |
| Laurens Van Houtven | 290aba1 | 2014-03-14 15:20:18 +0100 | [diff] [blame] | 3 | |
| Laurens Van Houtven | 36a2665 | 2014-03-15 21:52:25 +0100 | [diff] [blame] | 4 | First of all, thank you for your interest in contributing to pyOpenSSL! |
| Laurens Van Houtven | 290aba1 | 2014-03-14 15:20:18 +0100 | [diff] [blame] | 5 | |
| Laurens Van Houtven | 5a42298 | 2014-03-15 21:42:31 +0100 | [diff] [blame] | 6 | Filing bug reports |
| 7 | ------------------ |
| Laurens Van Houtven | 290aba1 | 2014-03-14 15:20:18 +0100 | [diff] [blame] | 8 | |
| Laurens Van Houtven | 36a2665 | 2014-03-15 21:52:25 +0100 | [diff] [blame] | 9 | Bug reports are very welcome. |
| 10 | Please file them on the Github issue tracker. |
| 11 | Good bug reports come with extensive descriptions of the error and how to reproduce it. |
| 12 | Reporters are strongly encouraged to include an `SSCCE <http://www.sscce.org/>`_. |
| Laurens Van Houtven | 290aba1 | 2014-03-14 15:20:18 +0100 | [diff] [blame] | 13 | |
| Laurens Van Houtven | 5a42298 | 2014-03-15 21:42:31 +0100 | [diff] [blame] | 14 | Patches |
| 15 | ------- |
| Laurens Van Houtven | 290aba1 | 2014-03-14 15:20:18 +0100 | [diff] [blame] | 16 | |
| Laurens Van Houtven | 36a2665 | 2014-03-15 21:52:25 +0100 | [diff] [blame] | 17 | All patches to pyOpenSSL should be submitted in the form of pull requests to the main pyOpenSSL repository, ``pyca/pyopenssl``. |
| 18 | These pull requests should satisfy the following properties: |
| Laurens Van Houtven | 290aba1 | 2014-03-14 15:20:18 +0100 | [diff] [blame] | 19 | |
| Laurens Van Houtven | 36a2665 | 2014-03-15 21:52:25 +0100 | [diff] [blame] | 20 | - Code should follow `PEP 8`_, especially in the "do what code around you does" sense. |
| 21 | One notable way pyOpenSSL code differs, for example, is that there should be three empty lines between module-level elements, and two empty lines between class-level elements. |
| 22 | Methods and functions are named in ``snake_case``. |
| 23 | Follow OpenSSL naming for callables whenever possible is preferred. |
| 24 | - Pull requests that introduce code must test all new behavior they introduce, as well as previously untested or poorly tested behavior that they touch. |
| Laurens Van Houtven | 290aba1 | 2014-03-14 15:20:18 +0100 | [diff] [blame] | 25 | - Pull requests are not allowed to break existing tests. |
| Laurens Van Houtven | 36a2665 | 2014-03-15 21:52:25 +0100 | [diff] [blame] | 26 | - Pull requests that introduce features or fix bugs should note those changes in the ``ChangeLog`` text file in the root of the repository. |
| 27 | They should also document the changes, both in docstrings and in the documentation in the ``doc/`` directory. |
| Laurens Van Houtven | 290aba1 | 2014-03-14 15:20:18 +0100 | [diff] [blame] | 28 | |
| Laurens Van Houtven | 36a2665 | 2014-03-15 21:52:25 +0100 | [diff] [blame] | 29 | Finally, pull requests must be reviewed before merging. |
| 30 | This process mirrors the `cryptography code review process`_. |
| 31 | Everyone can perform reviews; this is a very valuable way to contribute, and is highly encouraged. |
| Laurens Van Houtven | 290aba1 | 2014-03-14 15:20:18 +0100 | [diff] [blame] | 32 | |
| Laurens Van Houtven | 83b3e09 | 2014-03-16 15:06:24 +0100 | [diff] [blame^] | 33 | Pull requests are merged by members of the `pyopenssl-committers team <https://github.com/orgs/pyca/teams/pyopenssl-committers>`_. |
| 34 | They should, of course, keep all the requirements detailed in this document as well as the pyca/cryptography merge requirements in mind. |
| Laurens Van Houtven | 290aba1 | 2014-03-14 15:20:18 +0100 | [diff] [blame] | 35 | |
| Laurens Van Houtven | 36a2665 | 2014-03-15 21:52:25 +0100 | [diff] [blame] | 36 | The final responsibility for the reviewing of merged code lies with the person merging it; since pyOpenSSL is obviously a sensitive project from a security perspective, so reviewers are strongly encouraged to take this review and merge process very seriously. |
| Laurens Van Houtven | 290aba1 | 2014-03-14 15:20:18 +0100 | [diff] [blame] | 37 | |
| Laurens Van Houtven | 757807e | 2014-03-15 21:49:03 +0100 | [diff] [blame] | 38 | .. _PEP 8: http://legacy.python.org/dev/peps/pep-0008/ |
| Laurens Van Houtven | 5a42298 | 2014-03-15 21:42:31 +0100 | [diff] [blame] | 39 | .. _cryptography code review process: https://cryptography.io/en/latest/development/reviewing-patches/ |