From a007755400344fe1418d74add9787d2ab0482ca7 Mon Sep 17 00:00:00 2001 From: toonn Date: Tue, 9 Oct 2018 18:12:14 +0200 Subject: Document shellcheck in Makefile help and HACKING.md --- HACKING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'HACKING.md') diff --git a/HACKING.md b/HACKING.md index 6e200a43..aeb4f072 100644 --- a/HACKING.md +++ b/HACKING.md @@ -7,8 +7,8 @@ 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. * 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 -- cgit 1.4.1-2-gfad0 From 85e1c59ab9f918a2437fda8161b68cc1934ef33e Mon Sep 17 00:00:00 2001 From: toonn Date: Tue, 9 Oct 2018 19:12:52 +0200 Subject: Mention the test_py target in HACKING.md --- HACKING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'HACKING.md') diff --git a/HACKING.md b/HACKING.md index aeb4f072..c3faf3ca 100644 --- a/HACKING.md +++ b/HACKING.md @@ -8,7 +8,9 @@ Coding Style * 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`, - `pytest`, `doctest` and `shellcheck` need to be installed. + `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 -- cgit 1.4.1-2-gfad0