Skip to content

Commit d260d42

Browse files
authored
Update CLAUDE.md (#7069)
Signed-off-by: Nicholas Gates <nick@nickgates.com>
1 parent 402d5ce commit d260d42

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

CLAUDE.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
time you reach a stopping point or think you've finished work.
99
* run `cargo +nightly fmt --all` to format Rust source files. Please do this every time you reach a stopping point or
1010
think you've finished work.
11+
* run `cargo xtask public-api` to re-generate the public API lock files. Please do this every time you reach a stopping
12+
point or think you've finished work.
1113
* you can try running
1214
`cargo fix --lib --allow-dirty --allow-staged && cargo clippy --fix --lib --allow-dirty --allow-staged` to
1315
automatically many fix minor errors.
@@ -47,8 +49,11 @@
4749
* Prefer having test return VortexResult<()> and use ? over unwrap.
4850
* All imports must be at the top of the module, never inside functions. The only exception is `#[cfg(test)]` blocks,
4951
where imports should be at the top of the test module. Function-scoped imports are only acceptable when (a) required,
50-
or (b) it would be exceptionally verbose otherwise, such as a match statement where left and right sides have similar names.
51-
* Only write comments that explain non-obvious logic or important context. Avoid commenting simple or self-explanatory code.
52+
or (b) it would be exceptionally verbose otherwise, such as a match statement where left and right sides have similar
53+
names.
54+
* Imports should be preferred over qualified identifiers.
55+
* Only write comments that explain non-obvious logic or important context. Avoid commenting simple or self-explanatory
56+
code.
5257
* Use `assert_arrays_eq!` macro for comparing arrays in tests instead of element-by-element comparison.
5358
* Keep tests concise and to the point - avoid unnecessary setup or verbose assertions.
5459
* Run tests for a specific crate with `cargo test -p <crate-name>` (e.g., `cargo test -p vortex-array`).

0 commit comments

Comments
 (0)