diff options
| author | Jean-Paul Calderone <exarkun@twistedmatrix.com> | 2014-03-16 10:17:09 -0400 |
|---|---|---|
| committer | Jean-Paul Calderone <exarkun@twistedmatrix.com> | 2014-03-16 10:17:09 -0400 |
| commit | 0679a69b4da8929f2c794c7190be0a2df7c7329e (patch) | |
| tree | b5c26b51d28ad8d94c2f7e3ddee64429b2655a81 /CONTRIBUTING.rst | |
| parent | 83b3e09d68e1fb08be469f0150e2da1a30abfce5 (diff) | |
| download | pyopenssl-0679a69b4da8929f2c794c7190be0a2df7c7329e.tar.gz | |
minor tweaks
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 4495381..1bfa8f9 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -9,7 +9,7 @@ Filing bug reports Bug reports are very welcome. Please file them on the Github issue tracker. Good bug reports come with extensive descriptions of the error and how to reproduce it. -Reporters are strongly encouraged to include an `SSCCE <http://www.sscce.org/>`_. +Reporters are strongly encouraged to include an `short, self contained, correct example <http://www.sscce.org/>`_. Patches ------- @@ -17,11 +17,14 @@ Patches All patches to pyOpenSSL should be submitted in the form of pull requests to the main pyOpenSSL repository, ``pyca/pyopenssl``. These pull requests should satisfy the following properties: +- The branch referenced should be a feature branch focusing on one particular improvement to pyOpenSSL. + Create different branches and different pull requests for unrelated features or bugfixes. +- The branch referenced should have a distinctive name (in particular, please do not open pull requests for your ``master`` branch). - Code should follow `PEP 8`_, especially in the "do what code around you does" sense. - 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. + 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. Methods and functions are named in ``snake_case``. Follow OpenSSL naming for callables whenever possible is preferred. -- Pull requests that introduce code must test all new behavior they introduce, as well as previously untested or poorly tested behavior that they touch. +- Pull requests that introduce code must test all new behavior they introduce as well as for previously untested or poorly tested behavior that they touch. - Pull requests are not allowed to break existing tests. - Pull requests that introduce features or fix bugs should note those changes in the ``ChangeLog`` text file in the root of the repository. They should also document the changes, both in docstrings and in the documentation in the ``doc/`` directory. |