Skip to content

Commit 8f1cbde

Browse files
committed
docs: add machete, cargo doc, and fmt details to CI checklist in CLAUDE.md
1 parent bc2c251 commit 8f1cbde

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

CLAUDE.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,16 +253,18 @@ Environment variables set during test-all:
253253

254254
**MUST** (required for merge):
255255
- [ ] `cargo clippy --workspace --all-features --tests` passes with no warnings
256-
- [ ] `cargo +nightly fmt -- --check` passes
256+
- [ ] `cargo +nightly fmt --all -- --check` passes (run `cargo +nightly fmt --all` to fix; applies to **all** changed `.rs` files including tests — CI checks every file, not just lib code)
257257
- [ ] `debug_assert!` for non-obvious invariants
258258
- [ ] No `unwrap()` in library code
259259
- [ ] No silent error ignoring (`let _ =`)
260260
- [ ] New files under 500 lines (split by responsibility if larger)
261261
- [ ] No unnecessary `.clone()` (OK in actor/async code for clarity)
262262
- [ ] Tests through production path (HTTP/gRPC)
263-
- [ ] License headers present (run `bash quickwit/scripts/check_license_headers.sh`)
263+
- [ ] License headers present (run `bash quickwit/scripts/check_license_headers.sh` — every `.rs`, `.proto`, and `.py` file needs the Apache 2.0 header)
264264
- [ ] Log format correct (run `bash quickwit/scripts/check_log_format.sh`)
265265
- [ ] `typos` passes (spellcheck)
266+
- [ ] `cargo machete` passes (no unused dependencies in Cargo.toml)
267+
- [ ] `cargo doc --no-deps` passes (each PR must compile independently, not just the final stack)
266268
- [ ] Tests pass: `cargo nextest run --all-features`
267269

268270
**SHOULD** (expected unless justified):

0 commit comments

Comments
 (0)