aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorLaurens Van Houtven <_@lvh.cc>2013-08-07 11:03:40 +0200
committerLaurens Van Houtven <_@lvh.cc>2013-08-07 11:03:40 +0200
commit380a36974c36fc981288fd77b119e49dd63a43c9 (patch)
treeb1898d0e9fd67780052fe2abd448ead3a917c093 /CONTRIBUTING.rst
parent86d5db8d3619be5a2dbb8c354a5bb861295dfd32 (diff)
downloadcryptography-380a36974c36fc981288fd77b119e49dd63a43c9.tar.gz
cryptography-380a36974c36fc981288fd77b119e49dd63a43c9.tar.bz2
cryptography-380a36974c36fc981288fd77b119e49dd63a43c9.zip
Change CONTRIBUTING to ReST, use better docstring syntax
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
new file mode 100644
index 00000000..539da50f
--- /dev/null
+++ b/CONTRIBUTING.rst
@@ -0,0 +1,21 @@
+This repository has a mandatory code review policy. Contributions
+should happen through pull requests. Never commit to ``master``
+directly.
+
+When in doubt, refer to PEP 8 for Python code.
+
+Write docstrings like this::
+
+ 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.