8000 Update rules for CONTRIBUTING · n1k0/github3.py@6228999 · GitHub
[go: up one dir, main page]

Skip to content

Commit 6228999

Browse files
committed
Update rules for CONTRIBUTING
1 parent 90ce44a commit 6228999

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ Guidelines for Contributing to github3.py
2727
please open an issue reqeust first and of course add tests to cover the
2828
functionality in the event it is accepted.
2929

30+
Also, please be certain to add docstrings_ to these functions. Follow the
31+
example of other docstrings.
32+
3033
5. In case you haven't caught on, for anything you add, write tests.
3134

3235
6. Be cordial_.
@@ -35,5 +38,10 @@ Guidelines for Contributing to github3.py
3538
request. This makes my life easier. If you honestly have no idea what I'm
3639
talking about, don't worry, I'll take care of it.
3740

41+
8. Please follow pep-0008_. Feel free to also use flake8_ to help.
42+
3843
.. links
3944
.. _cordial: http://kennethreitz.com/be-cordial-or-be-on-your-way.html
45+
.. _pep-0008: http://www.python.org/dev/peps/pep-0008/
46+
.. _docstrings: http://www.python.org/dev/peps/pep-0257/
47+
.. _flake8: http://pypi.python.org/pypi/flake8

0 commit comments

Comments
 (0)
0