about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authortoonn <toonn@toonn.io>2018-10-09 18:12:14 +0200
committertoonn <toonn@toonn.io>2019-06-18 13:26:21 +0200
commita007755400344fe1418d74add9787d2ab0482ca7 (patch)
treeacc677ec26eac526131b2fd2de4c1baa0c684097
parente91ae58705d244f347c09c1c538245c02b0ea1ba (diff)
downloadranger-a007755400344fe1418d74add9787d2ab0482ca7.tar.gz
Document shellcheck in Makefile help and HACKING.md
-rw-r--r--HACKING.md4
-rw-r--r--Makefile31
2 files changed, 18 insertions, 17 deletions
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
diff --git a/Makefile b/Makefile
index c4bd5bb2..3f6e459d 100644
--- a/Makefile
+++ b/Makefile
@@ -38,21 +38,22 @@ options: help
 	@echo 'DESTDIR = $(DESTDIR)'
 
 help:
-	@echo 'make:              Test and compile ranger.'
-	@echo 'make install:      Install $(NAME)'
-	@echo 'make pypi_sdist:   Release a new sdist to PyPI'
-	@echo 'make clean:        Remove the compiled files (*.pyc, *.pyo)'
-	@echo 'make doc:          Create the pydoc documentation'
-	@echo 'make cleandoc:     Remove the pydoc documentation'
-	@echo 'make man:          Compile the manpage with "pod2man"'
-	@echo 'make manhtml:      Compile the html manpage with "pod2html"'
-	@echo 'make snapshot:     Create a tar.gz of the current git revision'
-	@echo 'make test:         Test everything'
-	@echo 'make test_pylint:  Test using pylint'
-	@echo 'make test_flake8:  Test using flake8'
-	@echo 'make test_doctest: Test using doctest'
-	@echo 'make test_pytest:  Test using pytest'
-	@echo 'make todo:         Look for TODO and XXX markers in the source code'
+	@echo 'make:                 Test and compile ranger.'
+	@echo 'make install:         Install $(NAME)'
+	@echo 'make pypi_sdist:      Release a new sdist to PyPI'
+	@echo 'make clean:           Remove the compiled files (*.pyc, *.pyo)'
+	@echo 'make doc:             Create the pydoc documentation'
+	@echo 'make cleandoc:        Remove the pydoc documentation'
+	@echo 'make man:             Compile the manpage with "pod2man"'
+	@echo 'make manhtml:         Compile the html manpage with "pod2html"'
+	@echo 'make snapshot:        Create a tar.gz of the current git revision'
+	@echo 'make test:            Test everything'
+	@echo 'make test_pylint:     Test using pylint'
+	@echo 'make test_flake8:     Test using flake8'
+	@echo 'make test_doctest:    Test using doctest'
+	@echo 'make test_pytest:     Test using pytest'
+	@echo 'make test_shellcheck: Test using shellcheck'
+	@echo 'make todo:            Look for TODO and XXX markers in the source code'
 
 install:
 	$(PYTHON) setup.py install $(SETUPOPTS) \