Document that contributors should run `make check`

Signed-off-by: Omar Sandoval <osandov@fb.com>

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7ee6194e134b538b923fbe7b8e2437cccd26b178..8aff384cbdac7181a68c8d709f436801035864a3 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -10,3 +10,7 @@ format.subjectPrefix "PATCH blktests"`.
 All commits must be signed off (i.e., `Signed-off-by: Jane Doe <janedoe@example.org>`)
 as per the [Developer Certificate of Origin](https://developercertificate.org/).
 `git commit -s` and `git format-patch -s` can do this for you.
+
+Please run `make check` before submitting a new test. This runs the
+[shellcheck](https://github.com/koalaman/shellcheck) static analysis tool and
+some other sanity checks.

diff --git a/new b/new
index b1f592c5946871126b1ca8b5e7e113b00597c02e..a62bcb7a15d80ced545bf9d4a46e73b1404ab14e 100755 (executable)
--- a/new
+++ b/new
@@ -259,6 +259,9 @@ test() {
 # - Use the \$() form of command substitution instead of backticks.
 # - Use bash for loops instead of seq. E.g., for ((i = 0; i < 10; i++)), not
 #   for i in \$(seq 0 9).
+#
+# Please run \`make check\` after your test is done to check for shell
+# scripting errors and other mistakes.
 EOF
 chmod +x "tests/${test_name}"
 echo "Created tests/${test_name}"