Skip to content

AGENTS.md

Latest commit

 

History

History
60 lines (44 loc) · 1.99 KB

AGENTS.md

File metadata and controls

60 lines (44 loc) · 1.99 KB
Raw

Agent Guidelines for Apache DataFusion

Developer Documentation

Before Committing

Before committing any changes, you MUST follow the instructions in Before Submitting a PR and ensure the required checks listed there pass. Do not commit code that fails any of those checks.

At a minimum, you MUST run and fix any errors from these commands before committing:

# Format code
cargo fmt --all

# Lint (must pass with no warnings)
cargo clippy --all-targets --all-features -- -D warnings

You can also run the full lint suite used by CI:

./dev/rust_lint.sh
# or auto-fix: ./dev/rust_lint.sh --write --allow-dirty

When creating a PR, you MUST follow the PR template.

Testing

If documentation files changed then run

./ci/scripts/doc_prettier_check.sh --write --allow-dirty

Otherwise, run extended tests

RUST_BACKTRACE=1 cargo test --profile ci \
    --exclude datafusion-examples --exclude datafusion-benchmarks --exclude datafusion-cli \
    --workspace --lib --tests --bins \
    --features avro,json,backtrace,extended_tests,recursive_protection,parquet_encryption

For modified code identify local benchmarks(if any) and run them against main. See Benchmarks.

Agent Skills

Repository-specific agent skills live under .ai/skills/. Each subdirectory is a single skill with a SKILL.md (YAML frontmatter + body). Check that directory for applicable skills before working on a task; new skills go in .ai/skills/<skill-name>/SKILL.md.