diff options
| author | Donald Stufft <donald@stufft.io> | 2013-08-11 02:18:44 -0700 |
|---|---|---|
| committer | Donald Stufft <donald@stufft.io> | 2013-08-11 02:18:44 -0700 |
| commit | 7ad6a1d5a6d9098d770229b13feb17c91ecf0d8f (patch) | |
| tree | 01886173a452559fb7043f91e33155e0186ef346 | |
| parent | ccc5062166f673c0b572c4e3344c8f5a61661d50 (diff) | |
| parent | 43f6873de4f5d0763172b017b514ff1f6807249a (diff) | |
| download | cryptography-7ad6a1d5a6d9098d770229b13feb17c91ecf0d8f.tar.gz cryptography-7ad6a1d5a6d9098d770229b13feb17c91ecf0d8f.tar.bz2 cryptography-7ad6a1d5a6d9098d770229b13feb17c91ecf0d8f.zip | |
Merge pull request #35 from hynek/add-new-file-requirements-to-contributing
Add requirements for code files to CONTRIBUTING
| -rw-r--r-- | CONTRIBUTING.rst | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ff1a619c..3ee89b80 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -10,6 +10,13 @@ Code When in doubt, refer to `PEP 8`_ for Python code. +Every code file must start with the boilerplate notice of the Apache License. +Additionally, every Python code file must contain + +.. code-block:: python + + from __future__ import absolute_import, division, print_function + Docs ==== @@ -17,12 +24,12 @@ Write docstrings like this: .. code-block:: python - def some_function(some_arg): - """ - Does some things. + def some_function(some_arg): + """ + Does some things. - :param some_arg: Some argument. - """ + :param some_arg: Some argument. + """ So, specifically: |