From: Omar Sandoval <osandov@fb.com>
Date: Wed, 25 Apr 2018 23:09:55 +0000 (-0700)
Subject: Document that contributors should run `make check`
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=5e46f78ba0702f7aa604a8e8537345bce5d05dda;p=users%2Fsagi%2Fblktests.git

Document that contributors should run `make check`

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

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7ee6194..8aff384 100644
--- 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 b1f592c..a62bcb7 100755
--- 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}"