Skip to content

Commit 31b5671

Browse files
chore[claude]: update claude.md (#5318)
Signed-off-by: Joe Isaacs <[email protected]>
1 parent 192a9d1 commit 31b5671

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

CLAUDE.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,13 @@
44

55
* project is a monorepo Rust workspace, java bindings in `/java`, python bindings in `/vortex-python`
66
* run `cargo build -p` to build a specific crate
7-
* use `cargo clippy --all-targets --all-features` to make sure a project is free of lint issues. Please do this every time you reach a stopping point or think you've finished work.
8-
* run `cargo +nightly fmt --all` to format Rust source files. Please do this every time you reach a stopping point or think you've finished work.
9-
* you can try running `cargo fix --lib --allow-dirty --allow-staged && cargo clippy --fix --lib --allow-dirty --allow-staged` to automatically many fix minor errors.
7+
* use `cargo clippy --all-targets --all-features` to make sure a project is free of lint issues. Please do this every
8+
time you reach a stopping point or think you've finished work.
9+
* run `cargo +nightly fmt --all` to format Rust source files. Please do this every time you reach a stopping point or
10+
think you've finished work.
11+
* you can try running
12+
`cargo fix --lib --allow-dirty --allow-staged && cargo clippy --fix --lib --allow-dirty --allow-staged` to
13+
automatically many fix minor errors.
1014

1115
## Architecture
1216

@@ -31,8 +35,10 @@
3135
* Use `vortex_err!` to create a `VortexError` with a format string and `vortex_bail!` to do the same but immediately
3236
return it as a `VortexResult<T>` to the surrounding context.
3337
* When writing tests, strongly consider using `rstest` cases to parameterize repetitive test logic.
34-
* If you want to create a large number of tests to an existing file module called `foo.rs`, and if you think doing so would
35-
be too many to inline in a `tests` submodule within `foo.rs`, then first promote `foo` to a directory module. You can do
38+
* If you want to create a large number of tests to an existing file module called `foo.rs`, and if you think doing so
39+
would
40+
be too many to inline in a `tests` submodule within `foo.rs`, then first promote `foo` to a directory module. You can
41+
do
3642
this by running `mkdir foo && mv foo.rs foo/mod.rs`. Then, you can create a test file `foo/tests.rs` that you include
3743
in `foo/mod.rs` with the appropriate test config flag.
3844
* If you encounter clippy errors in tests that should only pertain to production code (e.g., prohibiting panic/unwrap,
@@ -45,3 +51,7 @@
4551
## Other
4652

4753
* When summarizing your work, please produce summaries in valid Markdown that can be easily copied/pasted to Github.
54+
55+
## Commits
56+
57+
* All commits must be signed of by the committers in the form `Signed-off-by: "COMMITTER" <COMMITTER_EMAIL>`.

0 commit comments

Comments
 (0)