dcapwell commented on code in PR #4734: URL: https://github.com/apache/cassandra/pull/4734#discussion_r3074260941
########## AGENTS.md: ########## @@ -0,0 +1,79 @@ +# Agent Instructions for Apache Cassandra + +> These instructions apply to all AI-assisted contributions to `apache/cassandra`. + +## Apache Cassandra +Apache Cassandra is a NoSQL distributed database. This is the official Git repository + +## Environment + +- Java 11 (default) or 17. +- Python 3 for `cqlsh` and dtests. +- Apache Ant >= 1.10 for all builds. Do NOT attempt to use Maven, Gradle, or any other build tool. Cassandra uses Ant exclusively. +- Do NOT attempt to install dependencies, you do not have Internet access + +## Build + +```bash +ant build # compile all classes (includes Accord submodule) +ant jar # build the main JAR +ant clean # remove locally created artifacts +ant realclean # remove entire build directory and downloaded artifacts +``` + +Do NOT run `ant build` if you only need to verify a small change compiles. + +## Testing + +- Do NOT run the entire test suite(`ant test`). Run only the specific test(s) relevant to your change. + + ```bash + # Run a single unit test class + ant testsome -Dtest.name=org.apache.cassandra.service.StorageServiceServerTest -Dtest.methods=testGetAllRangesEmpty + ``` + +- When fixing a bug, first create a regression test that reproduces the failure, then implement the fix and verify. Review Comment: not a blocker for this patch, but this is an area where skills can help. How to work with CQLTester, how to work with jvm-dtest, how to work with `qt` or `stateful`, how to work with the simulator; etc. > first create a regression test that reproduces the failure do we have any example JIRA where this went well? I find claude makes really horrible tests. It will try to create a fake unit test that makes no sense then it defines success as it made the logic handle its test... but you actually go through Cassandra and everything is broken. -- 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]
