diff options
author | Hynek Schlawack <hs@ox.cx> | 2013-09-09 23:54:40 -0700 |
---|---|---|
committer | Hynek Schlawack <hs@ox.cx> | 2013-09-09 23:54:40 -0700 |
commit | 29828520d833b0be94e0755785ad0f0a42cd35e6 (patch) | |
tree | 66c216958006b7422d5ab880238c3b4620076117 /CONTRIBUTING.rst | |
parent | 7816628adbaa41df6652cc1b8cd2f50ad934e573 (diff) | |
parent | 2c67c82b9674c87085d30e6127c863b4b2c29966 (diff) | |
download | cryptography-29828520d833b0be94e0755785ad0f0a42cd35e6.tar.gz cryptography-29828520d833b0be94e0755785ad0f0a42cd35e6.tar.bz2 cryptography-29828520d833b0be94e0755785ad0f0a42cd35e6.zip |
Merge pull request #54 from alex/document-contributing
More fully document the contribution process
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r-- | CONTRIBUTING.rst | 48 |
1 files changed, 10 insertions, 38 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/ |