diff options
| -rw-r--r-- | CONTRIBUTING.rst | 48 | ||||
| -rw-r--r-- | docs/contributing.rst | 80 | ||||
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | tests/primitives/test_nist.py | 4 |
4 files changed, 93 insertions, 40 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 3ee89b80..9575e845 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,43 +1,15 @@ -Process -======= +Contributing to cryptography +============================ -This repository has a mandatory code review policy. Contributions -should happen through pull requests. Never commit to ``master`` -directly. +As an open source project, cryptography welcomes contributions of many forms. -Code -==== +Examples of contributions include: -When in doubt, refer to `PEP 8`_ for Python code. +* Code patches +* Documentation improvements +* Bug reports and patch reviews -Every code file must start with the boilerplate notice of the Apache License. -Additionally, every Python code file must contain +Extensive contribution guidelines are available in the repository at +``docs/contributing.rst``, or online at: -.. code-block:: python - - from __future__ import absolute_import, division, print_function - -Docs -==== - -Write docstrings like this: - -.. code-block:: python - - def some_function(some_arg): - """ - Does some things. - - :param some_arg: Some argument. - """ - -So, specifically: - -- Always use three double quotes. -- Put the three double quotes on their own line. -- No blank line at the end. -- Use Sphinx parameter/attribute documentation `syntax`_. - - -.. _`PEP 8`: http://www.peps.io/8/ -.. _`syntax`: http://sphinx-doc.org/domains.html#info-field-lists +https://cryptography.readthedocs.org/en/latest/contributing/ diff --git a/docs/contributing.rst b/docs/contributing.rst new file mode 100644 index 00000000..b4c72ba4 --- /dev/null +++ b/docs/contributing.rst @@ -0,0 +1,80 @@ +Contributing +============ + +Process +------- + +As an open source project, ``cryptography`` welcomes contributions of all +forms. These can include: + +* Bug reports and feature requests +* Pull requests for both code and documentation +* Patch reviews + +You can file bugs and submit pull requests on `GitHub`_. To discuss larger +changes you can start a conversation on `our mailing list`_. + +Because cryptography is so complex, and the implications of getting it wrong so +devastating, ``cryptography`` has a strict code review policy: + +* Patches must *never* be pushed directly to ``master``, all changes (even the + most trivial typo fixes!) must be submitted as a pull request. +* A committer may *never* merge their own pull request, a second party must + merge their changes. If multiple people work on a pull request, the merger + may not be any of them. +* A patch which breaks tests, or introduces regressions by changing or removing + existing tests should not be merged. Tests must always be passing on + ``master``. +* If somehow the tests get into a failing state on ``master`` (such as by a + backwards incompatible release of a dependency) no pull requests may be + merged until this is rectified. + +The purpose of these policies is to minimize the chances we merge a change +which jeopardizes our users' security. + +We do not yet have a formal security contact. To report security issues in +``cryptography`` you should email ``alex.gaynor@gmail.com``, messages may be +encrypted with PGP to key fingerprint +``E27D 4AA0 1651 72CB C5D2 AF2B 125F 5C67 DFE9 4084`` (this public key is +available from most commonly-used keyservers). + +Code +---- + +When in doubt, refer to `PEP 8`_ for Python code. + +Every code file must start with the boilerplate notice of the Apache License. +Additionally, every Python code file must contain + +.. code-block:: python + + from __future__ import absolute_import, division, print_function + +Documentation +------------- + +All features should be documented with prose. + +Docstrings should be written like this: + +.. code-block:: python + + def some_function(some_arg): + """ + Does some things. + + :param some_arg: Some argument. + """ + +So, specifically: + +- Always use three double quotes. +- Put the three double quotes on their own line. +- No blank line at the end. +- Use Sphinx parameter/attribute documentation `syntax`_. + + +.. _`GitHub`: https://github.com/alex/cryptography +.. _`our mailing list`: https://mail.python.org/mailman/listinfo/cryptography-dev +.. _`PEP 8`: http://www.peps.io/8/ +.. _`syntax`: http://sphinx-doc.org/domains.html#info-field-lists diff --git a/docs/index.rst b/docs/index.rst index 34996d7f..c8f63883 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,4 +32,5 @@ Contents architecture primitives/index + contributing community diff --git a/tests/primitives/test_nist.py b/tests/primitives/test_nist.py index 55756682..e736d4d1 100644 --- a/tests/primitives/test_nist.py +++ b/tests/primitives/test_nist.py @@ -44,7 +44,7 @@ def parameterize_encrypt_test(cipher, vector_type, params, fnames): class TestAES_CBC(object): @parameterize_encrypt_test( "AES", "KAT", - ["key", "iv", "plaintext", "ciphertext"], + ("key", "iv", "plaintext", "ciphertext"), [ "CBCGFSbox128.rsp", "CBCGFSbox192.rsp", @@ -71,7 +71,7 @@ class TestAES_CBC(object): @parameterize_encrypt_test( "AES", "MMT", - ["key", "iv", "plaintext", "ciphertext"], + ("key", "iv", "plaintext", "ciphertext"), [ "CBCMMT128.rsp", "CBCMMT192.rsp", |