Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add requirements for code files to CONTRIBUTING #35

Merged
merged 1 commit into from
Aug 11, 2013
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,26 @@ Code

When in doubt, refer to `PEP 8`_ for Python code.

Every code file must start with the boilerplate notice of the Apache License.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's be nice and not call it boilerplate :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that’s from http://choosealicense.com/licenses/apache/ ¯_(ツ)_/¯

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh. Ignore me then!

Additionally, every Python code file must contain

.. 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.
def some_function(some_arg):
"""
Does some things.

:param some_arg: Some argument.
"""
:param some_arg: Some argument.
"""

So, specifically:

Expand Down