summary refs log tree commit diff stats
path: root/HACKING.md
diff options
context:
space:
mode:
authortoonn <toonn@toonn.io>2019-06-20 16:54:51 +0200
committertoonn <toonn@toonn.io>2019-06-20 16:54:51 +0200
commitb1abf1327f38853f0101c585c2b1e868df400f9d (patch)
tree138fd48b3286e0eb55c9b3f1337ad553c3fde91a /HACKING.md
parent9ce8a9d9c39ab63736c8df112cbaaad0a38def23 (diff)
parent85445558bd57ffcadc05ca5b89ec76ec69a384bc (diff)
downloadranger-b1abf1327f38853f0101c585c2b1e868df400f9d.tar.gz
Merge branch 'shellcheck'
Diffstat (limited to 'HACKING.md')
-rw-r--r--HACKING.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/HACKING.md b/HACKING.md
index 6e200a43..c3faf3ca 100644
--- a/HACKING.md
+++ b/HACKING.md
@@ -7,8 +7,10 @@ Coding Style
 * Use syntax compatible with Python `2.6+` and `3.1+`.
 * Use docstrings with `pydoc` in mind
 * Follow the PEP8 style guide: https://www.python.org/dev/peps/pep-0008/
-* Always run `make test` before submitting a new PR. `pylint`, `flake8` and
-  `pytest` needs to be installed.
+* Always run `make test` before submitting a new PR. `pylint`, `flake8`,
+  `pytest`, `doctest` and `shellcheck` need to be installed. (If you don't
+  change any shell scripts you can run `make test_py` and you don't need the
+  `shellcheck` dependency but it's an awesome tool, so check it out : )
 * 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