Skip to content

Commit 303c9fa

Browse files
committed
docs: add developer checklist for editing workflow in AGENTS.md
1 parent 00fd3c0 commit 303c9fa

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

AGENTS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ This repository contains Python bindings for Rust's DataFusion.
2020
- Place typing-only imports under `if TYPE_CHECKING:` guards (Ruff rule `TCH001` is enforced).
2121
- In Rust examples/interop glue, prefer raw C string literals like `cr"..."` for small constants over allocating a `CString`.
2222

23+
## Developer checklist for an edit
24+
1. Run `uv run --no-project maturin develop --uv` (or `maturin develop --uv` inside the venv).
25+
2. Run `uv --no-project pytest .` or `python -m pytest python/tests` to validate changes.
26+
3. Run `pre-commit run --all-files` (or `./ci/scripts/python_lint.sh` and `./ci/scripts/rust_clippy.sh` / `./ci/scripts/rust_fmt.sh` for quick checks).
27+
2328
## Linting and formatting
2429
- Use pre-commit for linting/formatting.
2530
- Run hooks for changed files before committing:

0 commit comments

Comments
 (0)