hsiang-c commented on code in PR #4083: URL: https://github.com/apache/datafusion-comet/pull/4083#discussion_r3211610084
########## AGENTS.md: ########## @@ -0,0 +1,116 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> + +# Agent Guidelines for Apache DataFusion Comet + +## Developer Documentation + +- [Contributor Guide](docs/source/contributor-guide/index.md) +- [Development Guide](docs/source/contributor-guide/development.md) (build, test, common pitfalls) +- [Spark SQL Tests](docs/source/contributor-guide/spark-sql-tests.md) (working with Spark diffs) +- [Adding a New Expression](docs/source/contributor-guide/adding_a_new_expression.md) +- [Adding a New Operator](docs/source/contributor-guide/adding_a_new_operator.md) +- [Debugging Guide](docs/source/contributor-guide/debugging.md) + +## Building and Testing + +Comet is a mixed JVM/native project: Scala/Java code in `common/` and `spark/`, Rust code in +`native/`. The two sides communicate via JNI and Arrow FFI, and the build order matters. + +### Build order + +The native library must be built before any JVM tests, and `make` must have been run at least +once after cloning so that protobuf classes are generated for the JVM side. + +```bash +make # First-time setup: builds native + JVM, generates protobuf +make core # Rebuild native Rust code only (debug) +make test-jvm # Builds native first, then runs JVM tests +make test-rust # Builds common JVM first (for CometException), then runs cargo test +make test # Runs both Rust and JVM tests +``` + +If you edit Rust code and run JVM tests without rebuilding native, the tests will exercise the +old library. When in doubt, run `make` again. + +### Running specific JVM tests Review Comment: (nit) Maybe it is worthing mentioning the SQL tests b/c it is slightly different ### Running Comet [SQL Tests](https://datafusion.apache.org/comet/contributor-guide/sql-file-tests.html#running-the-tests) ```bash ./mvnw test -Dsuites="org.apache.comet.CometSqlFileTestSuite" -Dtest=none ./mvnw test -Dsuites="org.apache.comet.CometSqlFileTestSuite create_named_struct" -Dtest=none # run a single test file ``` -- 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]
