Skip to content

Commit 7c4bd1e

Browse files
committed
docs: add AGENTS instructions and development workflow guidelines in AGENTS.md
1 parent be88837 commit 7c4bd1e

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

AGENTS.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# AGENTS Instructions
2+
3+
This repository contains Python bindings for Rust's DataFusion.
4+
5+
## Development workflow
6+
- Ensure git submodules are initialized: `git submodule update --init`.
7+
- Build the Rust extension before running tests:
8+
- `uv run --no-project maturin develop --uv`
9+
- Run tests with pytest:
10+
- `uv --no-project pytest .`
11+
12+
## Linting and formatting
13+
- Use pre-commit for linting/formatting.
14+
- Run hooks for changed files before committing:
15+
- `pre-commit run --files <files>`
16+
- or `pre-commit run --all-files`
17+
- Hooks enforce:
18+
- Python linting/formatting via Ruff
19+
- Rust formatting via `cargo fmt`
20+
- Rust linting via `cargo clippy`
21+
22+
## Notes
23+
- The repository mixes Python and Rust; ensure changes build for both languages.
24+
- If adding new dependencies, update `pyproject.toml` and run `uv sync --dev --no-install-package datafusion`.

0 commit comments

Comments
 (0)