Notes about style checking

rjust · Sep 7, 2024 · 9ccee24 · 9ccee24
1 parent da07d97
commit 9ccee24
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README_DEVELOPER.md b/README_DEVELOPER.md
@@ -148,3 +148,9 @@ final data set, if this is still the case.
 Related, the test patches (<bid>.test.patch) stored in the repo are also not used. I think we
 should remove these as well. Source patches are manually minimized, but test patches are
 not -- these can be easily regenerated by running a diff between the buggy and fixed revisions.
+
+#### Style
+
+Because shell scripts are error-prone, we run a style checker on them.  CI will
+not pass if the style checker issues warnings.  Please address each warning by
+either correcting the problem or suppressing the warning.