aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2013-09-09 21:44:26 -0700
committerAlex Gaynor <alex.gaynor@gmail.com>2013-09-09 21:44:26 -0700
commitc72e63fc52edc73012e6958d6d587524f64a10be (patch)
treee41c0b4f0b87fed0d005f4a7551b0eb725878010 /CONTRIBUTING.rst
parent7816628adbaa41df6652cc1b8cd2f50ad934e573 (diff)
downloadcryptography-c72e63fc52edc73012e6958d6d587524f64a10be.tar.gz
cryptography-c72e63fc52edc73012e6958d6d587524f64a10be.tar.bz2
cryptography-c72e63fc52edc73012e6958d6d587524f64a10be.zip
More fully document the contribution process, move most of the details from
CONTRIBUTING.rst to sphinx.
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst48
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/