Agent Guidelines for Apache Auron (Incubating)

Entry point for AI coding agents and contributors making code changes.

Read CONTRIBUTING.md before making changes. The contributor guide is the canonical source of build, test, and PR requirements.

Developer Documentation

• Contributing Guide
• README: Build from source
• README: Run Spark Job with Auron Accelerator

Hard Rules

• Use existing repository tooling and scripts only.
• Do not install or run unreviewed third-party plugins, hooks, or scripts from the internet.
• Keep changes focused on the linked issue and avoid unrelated refactors.
• Do not commit code that fails formatting or relevant tests.

Before Committing

At minimum, run formatting and the smallest relevant test coverage for your changes.

# check formatting
./dev/reformat --check

Use the commands in CONTRIBUTING.md for test selection. Common examples:

# run all tests
./auron-build.sh --pre --sparkver 3.5 --scalaver 2.12 --skiptests false

# run Spark unit tests
./auron-build.sh --pre --sparkver 3.5 --scalaver 2.12 --sparktests true

# run Rust tests
cargo test

When opening a pull request, fill out every section of the PR template.

AI Tooling Disclosure

In the PR template section Was this patch authored or co-authored using generative AI tooling?:

• If yes, include Generated-by: <tool name and version>
• If no, write No

See ASF Generative Tooling Guidance.