From 0757fe98dcb238133dcac664c972bdecb7b78b65 Mon Sep 17 00:00:00 2001 From: hut Date: Sat, 27 Aug 2016 00:04:00 +0200 Subject: Add github issue/PR templates --- .github/PULL_REQUEST_TEMPLATE.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md (limited to '.github/PULL_REQUEST_TEMPLATE.md') 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". :) -- cgit 1.4.1-2-gfad0