Skip to content

docs: add AGENTS.md with build, test, and Spark diff guidance#4083

Open
andygrove wants to merge 1 commit intoapache:mainfrom
andygrove:chore/add-agents-md
Open

docs: add AGENTS.md with build, test, and Spark diff guidance#4083
andygrove wants to merge 1 commit intoapache:mainfrom
andygrove:chore/add-agents-md

Conversation

@andygrove
Copy link
Copy Markdown
Member

@andygrove andygrove commented Apr 25, 2026

Which issue does this PR close?

Closes #3973

Rationale for this change

Add an AGENTS.md to make it easier for contributors working with agentic coding.

The structure follows the precedent set by Apache DataFusion's AGENTS.md: a thin pointer file rather than duplicated documentation.

What changes are included in this PR?

Adds a new AGENTS.md at the repository root with:

  • Links into the existing contributor guide (development, Spark SQL tests, debugging, adding expressions/operators).
  • A "Building and Testing" section that emphasizes the JVM/native build order, the -Dsuites / -Dtest=none invocation, why -pl should not be used, and the LD_LIBRARY_PATH requirement for cargo test.
  • A "Working with Spark Diffs" section that explicitly forbids hand-editing files under dev/diffs/ and links to the relevant sections of spark-sql-tests.md for the clone-Spark / apply / modify / regenerate workflow.
  • A "Before Committing" section listing make format, make, and cargo clippy, and a pointer to the PR template.

How are these changes tested?

N/A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add AGENTS.md

1 participant