diff options
author | Alex Gaynor <alex.gaynor@gmail.com> | 2013-08-07 07:32:52 -0700 |
---|---|---|
committer | Alex Gaynor <alex.gaynor@gmail.com> | 2013-08-07 07:32:52 -0700 |
commit | e4eb5a2ac4a4751dc30cffab541082347e366e13 (patch) | |
tree | b1898d0e9fd67780052fe2abd448ead3a917c093 | |
parent | 8d7fb752184873f2aa3c2cc375d1556d43920d1b (diff) | |
parent | 380a36974c36fc981288fd77b119e49dd63a43c9 (diff) | |
download | cryptography-e4eb5a2ac4a4751dc30cffab541082347e366e13.tar.gz cryptography-e4eb5a2ac4a4751dc30cffab541082347e366e13.tar.bz2 cryptography-e4eb5a2ac4a4751dc30cffab541082347e366e13.zip |
Merge pull request #2 from lvh/contributing
Simple CONTRIBUTING file, refs PEPs 8, 257
-rw-r--r-- | CONTRIBUTING.rst | 21 |
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. |