From c074c0d51a6e3c7924a2ddea3ea418729564a252 Mon Sep 17 00:00:00 2001 From: Miquel Sabaté Solà Date: Wed, 18 Mar 2020 15:26:55 +0100 Subject: Bringing shellcheck into the mix MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Miquel Sabaté Solà --- CONTRIBUTING.org | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'CONTRIBUTING.org') diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org index 9b9b07c..5c1a199 100644 --- a/CONTRIBUTING.org +++ b/CONTRIBUTING.org @@ -30,6 +30,15 @@ will just print a help message). This is done so when running the default make task this doesn't interrupt it. This task is already called by the default =test= one. +*** Shellcheck + +This project uses [[https://github.com/koalaman/shellcheck][shellcheck]] in order to validate the code style. In order to +run =shellcheck=, just perform: + +#+BEGIN_SRC bash +$ make shellcheck +#+END_SRC + ** Issue reporting I'm using [[https://github.com/mssola/writer-mode][Github]] in order to host the code. Thus, in order to report issues you -- cgit v1.2.3