lhotari commented on code in PR #25871: URL: https://github.com/apache/pulsar/pull/25871#discussion_r3304626145
########## AGENTS.md: ########## @@ -0,0 +1,59 @@ +# Agent guide for Apache Pulsar + +Supplemental guidance for AI coding assistants (Claude Code, Copilot, Cursor, Gemini, Codex, Aider, +and similar tools) working in this repository. Keep this file short — it is a **router**. The detail +lives in the human-facing docs and the task skills, which you should load **on demand** rather than +pulling everything into context up front. + +Apache Pulsar is a distributed pub-sub messaging and streaming platform. The codebase is +performance-critical, heavily asynchronous, and concurrency-sensitive. Prioritize **correctness, +thread safety, performance, maintainability, and backward compatibility**. + +## Canonical docs (read the one that fits the task) + +| Doc | Use for | +|-----|---------| +| [`CONTRIBUTING.md`](CONTRIBUTING.md) | Local dev workflow: build, lint, running tests & test groups, integration tests, Personal CI, PR conventions, security reporting. | +| [`ARCHITECTURE.md`](ARCHITECTURE.md) | Big-picture module map, the Gradle build infrastructure, the module-name-vs-directory gotcha, and the `pip/` proposals. | +| [`CODING.md`](CODING.md) | Coding conventions: style, async/`CompletableFuture`, concurrency, logging ([slog](https://github.com/merlimat/slog)), dependencies, backward compatibility, testing, and the review checklist. | +| [`SECURITY.md`](SECURITY.md) | Reporting a vulnerability, disclosure hygiene, and checking exposure to an already-public CVE. | + +The authoritative project documentation is at <https://pulsar.apache.org>; the files above and the Review Comment: added -- 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]
