dcapwell commented on code in PR #4734: URL: https://github.com/apache/cassandra/pull/4734#discussion_r3170269117
########## AGENTS.md: ########## @@ -0,0 +1,74 @@ +# 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), 17, 21. +- 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 +.build/sh/ai-build # clean, build JAR, and run checkstyle (output is summarized) +``` + +Do NOT call `ant` directly — always use the `ai-*` wrapper scripts which handle log summarization and correct working directory. + +## Testing + +- Do NOT run the entire test suite. Run only the specific test(s) relevant to your change. + + ```bash + # Run a single unit test class + .build/sh/ai-ci-test org.apache.cassandra.service.StorageServiceServerTest + ``` + +- `ai-ci-test` does NOT support method-level filtering — it runs the entire test class. +- When fixing a bug, first create a regression test that reproduces the failure, then implement the fix and verify. +- Provide test(s) coverage for all new or modified code. + +## Linting and Code Checks + +`.build/sh/ai-build` includes checkstyle validation. There is no need to run checkstyle separately. + +## Code Style +Cassandra enforces style via Checkstyle (run via `.build/sh/ai-build`). The official style guide is at https://cassandra.apache.org/_/development/code_style.html. Always defer to it when in doubt. Review Comment: i wonder if claude will still fetch this given above we said there isn't network... i have this in my agent and its almost never fetched... -- 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]
