Skip to content

Commit bd61b3b

Browse files
authored
docs: update the AGENTS.md (#158)
Update the AGENTS.md based on the current folder structure.
1 parent 1c199ac commit bd61b3b

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,15 @@
22

33
## Project Structure & Module Organization
44
- `crates/lance-graph/` hosts the Rust Cypher engine; keep new modules under `src/` and co-locate helpers inside `query/` or feature-specific submodules.
5+
- `crates/lance-graph-catalog/` provides catalog and namespace utilities, including Unity Catalog and Delta Lake integration; feature-gated via `unity-catalog`.
6+
- `crates/lance-graph-benches/` contains performance benchmarks in a dedicated unpublished crate; add new benchmarks here rather than in the main crate.
57
- `crates/lance-graph-python/src/` contains the PyO3 bridge; `python/python/lance_graph/` holds the pure-Python facade and packaging metadata.
68
- `python/python/tests/` stores functional tests; mirror new features with targeted cases here and in the corresponding Rust module.
79
- `examples/` demonstrates Cypher usage; update or add examples when introducing new public APIs.
810

911
## Build, Test, and Development Commands
1012
- `cargo check` / `cargo test --all` (run inside `crates/lance-graph`) validate Rust code paths.
11-
- `cargo bench --bench graph_execution` measures performance-critical changes; include shortened runs with `--warm-up-time 1`.
13+
- `cargo bench --bench graph_execution -p lance-graph-benches` measures performance-critical changes; include shortened runs with `--warm-up-time 1`.
1214
- `uv venv --python 3.11 .venv` and `uv pip install -e '.[tests]'` bootstrap the Python workspace.
1315
- `maturin develop` rebuilds the extension after Rust edits; `pytest python/python/tests/ -v` exercises Python bindings.
1416
- `make lint` (in `python/`) runs `ruff`, formatting checks, and `pyright`.

0 commit comments

Comments
 (0)