diff options
Diffstat (limited to '.github/PULL_REQUEST_TEMPLATE.md')
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..1aa748ad --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,9 @@ +* Use syntax compatible to both python 2.6+ and 3.1+. +* Use docstrings with pydoc in mind +* Follow the style guide for python code: + http://www.python.org/dev/peps/pep-0008/ +* Test the code with "doctest" where it makes sense +* when breaking backward compatibility with old configuration files or plugins, + please include a temporary workaround code that provides a compatibility + layer and mark it with a comment that includes the word "COMPAT". For + examples, grep the code for the word "COMPAT". :) |