asafm commented on code in PR #25871: URL: https://github.com/apache/pulsar/pull/25871#discussion_r3303993708
########## CLAUDE.md: ########## @@ -0,0 +1 @@ +AGENTS.md Review Comment: just symlink (ln -s ) ########## 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: Maybe place a link to the source of the docs? ########## .github/PULL_REQUEST_TEMPLATE.md: ########## @@ -1,18 +1,26 @@ <!-- ### Contribution Checklist - - - PR title format should be *[type][component] summary*. For details, see *[Guideline - Pulsar PR Naming Convention](https://pulsar.apache.org/contribute/develop-semantic-title/)*. + + - PR title format should be *[type][component] summary*. The valid `[type]` and `[component]`/scope + prefixes are enforced by CI (see `.github/workflows/ci-semantic-pull-request.yml`); for details, + see *[Guideline - Pulsar PR Naming Convention](https://pulsar.apache.org/contribute/develop-semantic-title/)*. - Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review. - + + - The **Motivation** and **Modifications** sections are required: explain *why* (the problem/context) + and *what/how* (the change). A title alone, or a description that only restates the title, is not enough. + - Each pull request should address only one issue, not mix up code from multiple issues. - + - Each commit in the pull request has a meaningful commit message + - For the local build/test/PR workflow see `CONTRIBUTING.md`, and for coding conventions see + `CODING.md`. If you use an AI coding assistant, see `AGENTS.md`. + - Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below. --> -<!-- Either this PR fixes an issue, --> +<!-- Either this PR fixes/closes an issue — use "Fixes #xyz" or, equivalently, "Closes #xyz", --> Review Comment: ? ########## .github/PULL_REQUEST_TEMPLATE.md: ########## @@ -1,18 +1,26 @@ <!-- ### Contribution Checklist - - - PR title format should be *[type][component] summary*. For details, see *[Guideline - Pulsar PR Naming Convention](https://pulsar.apache.org/contribute/develop-semantic-title/)*. + + - PR title format should be *[type][component] summary*. The valid `[type]` and `[component]`/scope + prefixes are enforced by CI (see `.github/workflows/ci-semantic-pull-request.yml`); for details, + see *[Guideline - Pulsar PR Naming Convention](https://pulsar.apache.org/contribute/develop-semantic-title/)*. - Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review. - + + - The **Motivation** and **Modifications** sections are required: explain *why* (the problem/context) + and *what/how* (the change). A title alone, or a description that only restates the title, is not enough. Review Comment: same ########## .github/PULL_REQUEST_TEMPLATE.md: ########## @@ -1,18 +1,26 @@ <!-- ### Contribution Checklist - - - PR title format should be *[type][component] summary*. For details, see *[Guideline - Pulsar PR Naming Convention](https://pulsar.apache.org/contribute/develop-semantic-title/)*. + + - PR title format should be *[type][component] summary*. The valid `[type]` and `[component]`/scope + prefixes are enforced by CI (see `.github/workflows/ci-semantic-pull-request.yml`); for details, + see *[Guideline - Pulsar PR Naming Convention](https://pulsar.apache.org/contribute/develop-semantic-title/)*. - Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review. - + + - The **Motivation** and **Modifications** sections are required: explain *why* (the problem/context) Review Comment: why this addition here? -- 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]
