Conversation
Document how CI builds and tests the workspace, conventions that are easy to miss, and the parts of the design that span several files, following the AGENTS.md files in other DataFusion repositories. Symlink CLAUDE.md to it, as apache/datafusion does. Closes apache#33.
andygrove
added a commit
to andygrove/datafusion-iceberg
that referenced
this pull request
Oct 1, 2026
apache#34 adds CLAUDE.md as a symlink to AGENTS.md. RAT reads symlinks in a source tarball as files without a license header, so exclude it, as apache/datafusion-comet and apache/datafusion-python do. AGENTS.md itself carries the header and is still checked.
gabotechs
approved these changes
Oct 2, 2026
gabotechs
left a comment
gabotechs
left a comment
Contributor
There was a problem hiding this comment.
👍 Looks good, as the project evolves we'll likely need to adapt this file, which is fine.
About testing, I want to push for an easily-reviewable e2e testing approach based on integration tests.
If you agree that to be a good testing approach, it's probably worth adding some guidance here as well (not in this PR if this goes in first)
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.
Which issue does this PR close?
Rationale for this change
Other DataFusion repositories give coding agents repository-specific instructions in an
AGENTS.md. This repository has none, so agents have to work out how CI builds and tests the code, and they miss conventions that aren't visible from any single file.What changes are included in this PR?
AGENTS.md, covering:unused_qualifications = "deny", rustfmt'smax_width = 90, the toolchain version pinned in two places, and ASF license headersInexactfilter pushdown, theINSERTpipeline, and error conversiondefault.default.<table>names, pre-created tables, and hand-maintainedEXPLAINexpectationsCLAUDE.mdas a symlink toAGENTS.md, as in apache/datafusion, apache/datafusion-comet and apache/datafusion-python.The file describes
mainas it is today. #32 renames the crate and adds a RAT license check, so whichever of the two lands second will updateAGENTS.mdfor those changes. RAT reads theCLAUDE.mdsymlink as a file without a license header, so #32 also excludes it, as Comet and datafusion-python do.What is the testing strategy for this PR?
This PR only adds documentation. I ran each command it documents against this branch. The targeted unit, integration and sqllogictest runs pass,
UPDATE_EXPECT=1leaves the tree unchanged, and the playground starts with an--rcfile and runs a query.Are there any user-facing changes?
No.