From 8238e144fd625ff63b9b3eeea0d4bbb856d6f897 Mon Sep 17 00:00:00 2001 From: Tyler Akins Date: Wed, 3 Aug 2016 10:24:56 -0500 Subject: [PATCH] Adding notes regarding ShellCheck --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index e23130d..115e527 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,8 @@ First you need to get the official tests. This command will pull them down and After that you need to install node.js and run `npm install async` (no, I didn't make a package.json to just list one dependency). Finally, `./run-spec.js spec/specs/*.json` will run against the official tests - there's over 100 of them. +When submitting patches, make sure to run them past [ShellCheck] and ensure no problems are found. Also please use Bash 3 syntax if you are manipulating arrays. + ### Porting and Backporting @@ -121,3 +123,4 @@ This program is licensed under an MIT license with an additional non-advertising [Mustache]: https://mustache.github.io/ +[ShellCheck]: https://github.com/koalaman/shellcheck