docs: coding style: shell scripts should be linted using shellcheck

[lttng-tools.git] / CodingStyle.md

diff --git a/CodingStyle.md b/CodingStyle.md
index b1f5be1ddd5a4ba7f2a415fc3a0c2806fd0bbf5b..ea9e9d2cb472c24dd66f24618570782d541bb9b5 100644 (file)
--- a/CodingStyle.md
+++ b/CodingStyle.md
@@ -267,6 +267,11 @@ Here are a couple of reminders:
 
 Python code should be formatted using [black](https://github.com/psf/black).
 
+## Shell (BASH)
+
+New scripts and modifications to existing scripts should pass linting
+with [Shellcheck](https://www.shellcheck.net/).
+
 ## C Style (historical)
 
 The coding style used for this project follows the the Linux kernel guide lines, except that brackets `{`, `}` should typically be used even for single-line if/else statements. Please refer to: