aboutsummaryrefslogtreecommitdiff
path: root/tests/README.md
diff options
context:
space:
mode:
authorGravatar Frans de Jonge <fransdejonge@gmail.com> 2019-07-24 05:26:51 +0200
committerGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2019-07-24 05:26:51 +0200
commitb12d261407a5daccb9cbda1801a58fb9799d61a2 (patch)
tree978ff83af9716b0b6d1f2a34f2a45324a7c12e41 /tests/README.md
parent61af33a6f58e15d88a08765046bbaf08be7dd49e (diff)
tests: add shellchecks and shfmt to README (#2458)
See https://github.com/FreshRSS/FreshRSS/pull/2454#discussion_r306174996
Diffstat (limited to 'tests/README.md')
-rw-r--r--tests/README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/tests/README.md b/tests/README.md
index 3dd9602be..fbc38ac4d 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -5,3 +5,7 @@ cd ./tests/
wget https://phar.phpunit.de/phpunit.phar
php phpunit.phar --bootstrap bootstrap.php
```
+
+The `shellchecks.sh` script is used to safeguard shell scripts from common
+shell script bugs and to ensure a consistent style.
+It requires [ShellCheck](https://www.shellcheck.net/) and [shfmt](https://github.com/mvdan/sh).