From c72e63fc52edc73012e6958d6d587524f64a10be Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Mon, 9 Sep 2013 21:44:26 -0700 Subject: More fully document the contribution process, move most of the details from CONTRIBUTING.rst to sphinx. --- CONTRIBUTING.rst | 48 ++++++++++-------------------------------------- 1 file changed, 10 insertions(+), 38 deletions(-) (limited to 'CONTRIBUTING.rst') 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/ -- cgit v1.2.3