AGENTS.md

Agent Guidelines for Apache Arrow-rs

This file is an entry point. Follow the detailed guidance in CONTRIBUTING.md and the documentation for the crates you change.

Developer Documentation

• Repository overview and crate list
• Crate READMEs: Arrow, Parquet, Arrow Flight, and the README for each affected crate
• Contributor guide
• Pull request template

Setup and Validation

Initialize test data before running tests or examples:

git submodule update --init

Run the checks relevant to your change from the repository root:

# Check Rust formatting and lints for code changes
cargo +stable fmt --all -- --check
cargo clippy --workspace --all-targets --all-features -- -D warnings

# Check spelling, including documentation changes
# If typos is not installed, run: cargo install typos-cli
typos --config typos.toml

# Run the full workspace test suite for code changes
cargo test --workspace

See the testing, formatting, Clippy, and spelling guidance for details.

Additional Checks

For performance work, see benchmarks. For memory-safety checks, see Miri. For public API changes, see breaking changes.