andygrove opened a new pull request, #4083: URL: https://github.com/apache/datafusion-comet/pull/4083
## Which issue does this PR close? <!-- We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123. --> N/A ## Rationale for this change Coding agents (Claude Code, Codex, Cursor, etc.) increasingly look for an `AGENTS.md` at the repo root for project-specific guidance. Comet's mixed JVM/native build is easy to get wrong (running JVM tests without rebuilding native, using `-pl spark` and silently testing against a stale `common`, hand-editing files under `dev/diffs/`), and the existing contributor docs already cover all of this in detail. A short top-level `AGENTS.md` that points agents at the right sections of the contributor guide should reduce these classes of mistakes. The structure follows the precedent set by [Apache DataFusion's AGENTS.md](https://github.com/apache/datafusion/blob/main/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. No code or build changes. ## How are these changes tested? Documentation-only change. Verified that all relative links in `AGENTS.md` resolve to existing files and section anchors in the repository, and that the file is formatted cleanly with Prettier. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
