docs: add AGENTS.md guidance for AI agents#984
Merged
Conversation
Document the codebase for AI coding agents in AGENTS.md: project overview and module layout (including build-logic, isthmus-cli, the Spark multi-version variants, and the inputs sourced from the substrait submodule), the core patterns most changes follow (Immutables POJOs, model-wide visitors, the ProtoConverter pairs, and in-enum proto mappings), the build/test/format workflow (PMD, the JDK 17 vs GraalVM native-image toolchain split, CI-vs-local task gaps), and conventions. CLAUDE.md imports it (@AGENTS.md) so Claude Code and other AGENTS.md-aware tools read the same instructions from a single source.
andrew-coleman
approved these changes
Jul 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
AGENTS.md— practical, codebase-specific guidance for AI coding agents — covering:build-logic(thesubstrait.java-conventionsincluded build),isthmus-cli(GraalVM native image), the Spark multi-version variants (shared source compiled against Spark 3.4/3.5 on Scala 2.12 and Spark 4.0 on Scala 2.13), and the inputs sourced from thesubstraitsubmodule (proto, ANTLR grammars, extension YAMLs, validation schemas).<Thing>ProtoConverter/Proto<Thing>Converterpairs, and the in-enumtoProto()/fromProto()mappings.build-logicdaemon-heap/--no-build-cachenotes, and the CI-vs-local task gaps (javadoc, submodule tags).CLAUDE.mdsimply imports it (@AGENTS.md) so Claude Code and other AGENTS.md-aware tools read the same instructions from a single source, without duplication.🤖 Generated with AI