From e6daf14639ec468fb5abc5a5920aceb7420ecbd8 Mon Sep 17 00:00:00 2001 From: Laurens Van Houtven <_@lvh.cc> Date: Wed, 7 Aug 2013 10:33:03 +0200 Subject: Simple CONTRIBUTING file, refs PEPs 8, 257 --- CONTRIBUTING | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 CONTRIBUTING diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 00000000..7b03ba02 --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,4 @@ +When in doubt, refer to PEP 8 for Python code. + +Use PEP 257 for docstring conventions, except use Sphinx notation for +arguments, attributes, et cetera. -- cgit v1.2.3 From 86d5db8d3619be5a2dbb8c354a5bb861295dfd32 Mon Sep 17 00:00:00 2001 From: Laurens Van Houtven <_@lvh.cc> Date: Wed, 7 Aug 2013 10:47:00 +0200 Subject: Mention mandatory code review policy --- CONTRIBUTING | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING b/CONTRIBUTING index 7b03ba02..3e47ec65 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -1,3 +1,6 @@ +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. Use PEP 257 for docstring conventions, except use Sphinx notation for -- cgit v1.2.3 From 380a36974c36fc981288fd77b119e49dd63a43c9 Mon Sep 17 00:00:00 2001 From: Laurens Van Houtven <_@lvh.cc> Date: Wed, 7 Aug 2013 11:03:40 +0200 Subject: Change CONTRIBUTING to ReST, use better docstring syntax --- CONTRIBUTING | 7 ------- CONTRIBUTING.rst | 21 +++++++++++++++++++++ 2 files changed, 21 insertions(+), 7 deletions(-) delete mode 100644 CONTRIBUTING create mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING b/CONTRIBUTING deleted file mode 100644 index 3e47ec65..00000000 --- a/CONTRIBUTING +++ /dev/null @@ -1,7 +0,0 @@ -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. - -Use PEP 257 for docstring conventions, except use Sphinx notation for -arguments, attributes, et cetera. 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. -- cgit v1.2.3