Document justfile

hannobraun · Dec 7, 2022 · 6295a66 · 6295a66
1 parent 53dd509
commit 6295a66
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/justfile b/justfile
@@ -1,5 +1,11 @@
 export RUSTDOCFLAGS := "-D warnings"
 
+# Run a full build that mirrors the CI build
+#
+# Basically, if this passes locally, then the CI build should pass too, once you
+# submit your work as a pull request. Please note that the CI build is
+# maintained separately from this file. Most deviations in behavior should
+# probably be considered a bug in this file.
 ci:
     cargo fmt --check
     cargo clippy --all-features -- -D warnings