summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorLaurens Van Houtven <_@lvh.cc>2014-03-15 21:49:03 +0100
committerLaurens Van Houtven <_@lvh.cc>2014-03-15 21:49:03 +0100
commit757807eea64120e4d19a4b0c8fe036f578a55ce7 (patch)
tree7a73beac205c7138284d755153f82997585051b7 /CONTRIBUTING.rst
parentdf531cc9559a8aea37438fee13359333962279b3 (diff)
downloadpyopenssl-757807eea64120e4d19a4b0c8fe036f578a55ce7.tar.gz
PEP8 + exceptions, not TCS
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst11
1 files changed, 7 insertions, 4 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index c43a1c7..1827d48 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -19,10 +19,12 @@ 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:
-- Pull requests that involve code must follow the
- `Twisted Coding Standard`_. For example, ``methodNamesLikeThis``,
- three empty lines between module-level elements, and two empty lines
- between class-level elements.
+- Code should mostly 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. 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.
@@ -46,4 +48,5 @@ 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.
+.. _PEP 8: http://legacy.python.org/dev/peps/pep-0008/
.. _cryptography code review process: https://cryptography.io/en/latest/development/reviewing-patches/