From 650ad783d76462ca63bf5c2cb1917633bcac2e05 Mon Sep 17 00:00:00 2001 From: Dan Puttick Date: Tue, 22 Aug 2017 16:19:31 -0400 Subject: [PATCH] Mention shellcheck in CONTRIBUTING.md --- CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d7e7b00..30017f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,7 +49,10 @@ IN ALL CASES, PLEASE READ THE COMMENTS IN THE SCRIPTS AT LEAST ONCE. Running the tests ================= -To emulate the Raspberry Pi hardware for testing, we'll be using +* If you've made changes to the shell scripts, start by installing and running +[Shellcheck](https://github.com/koalaman/shellcheck). + +* To emulate the Raspberry Pi hardware for testing, we'll be using [Qemu](http://wiki.qemu.org/Main_Page), an open source machine emulator. The "qemu" package available for Ubuntu/Debian includes all of the required packages (including qemu-system-arm) except for qemu-user-static, which must