summary refs log blame commit diff stats
path: root/.github/PULL_REQUEST_TEMPLATE.md
blob: 1aa748ada6243553bff7ecfbdc60b14695c84102 (plain) (tree)
1
2
3
4
5
6
7
8
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". :)