diff options
Diffstat (limited to 'HACKING.md')
| -rw-r--r-- | HACKING.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/HACKING.md b/HACKING.md index 68055555..b8f62d86 100644 --- a/HACKING.md +++ b/HACKING.md @@ -4,10 +4,10 @@ Guidelines for Code Modification Coding Style ------------ -* Use syntax compatible to both Python 2.6+ and 3.1+. +* Use syntax compatible with Python `2.6+` and `3.1+`. * Use docstrings with `pydoc` in mind -* Follow the style guide for python code: https://www.python.org/dev/peps/pep-0008/ -* Test the code with `doctest` where it makes sense +* Follow the PEP8 style guide: https://www.python.org/dev/peps/pep-0008/ +* Always run `make test` before submitting a new PR. `pylint` and `flake8` needs to be installed. * 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 |