diff options
| author | Miquel Sabaté Solà <msabate@suse.com> | 2020-03-18 15:26:55 +0100 |
|---|---|---|
| committer | Miquel Sabaté Solà <msabate@suse.com> | 2020-03-18 15:26:55 +0100 |
| commit | c074c0d51a6e3c7924a2ddea3ea418729564a252 (patch) | |
| tree | 4303ec17a2a534c5c78ebd089307ca444800f15d /CONTRIBUTING.org | |
| parent | ecdc723c96e0a92fdda3a754edb0302cdc2de9eb (diff) | |
| download | g-c074c0d51a6e3c7924a2ddea3ea418729564a252.tar.gz g-c074c0d51a6e3c7924a2ddea3ea418729564a252.zip | |
Bringing shellcheck into the mix
Signed-off-by: Miquel Sabaté Solà <msabate@suse.com>
Diffstat (limited to 'CONTRIBUTING.org')
| -rw-r--r-- | CONTRIBUTING.org | 9 |
1 files changed, 9 insertions, 0 deletions
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 |