-
Notifications
You must be signed in to change notification settings - Fork 3.7k
[improve][misc] Add AGENTS.md and split build/contributor/coding/architecture/security docs #25871
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
39 commits
Select commit
Hold shift + click to select a range
5dfde69
[improve][misc] Add AGENTS.md and update copilot-instructions.md
lhotari d6e0726
[improve][misc] Clarify thread leak detector false positives in test …
lhotari 84d12bd
[improve][misc] Require PR description to cover motivation and modifi…
lhotari 8056c25
[improve][misc] Restructure agent docs: split CONTRIBUTING/ARCHITECTU…
lhotari 149014c
[improve][misc] Add Closes alternative for Fixes and align PR templat…
lhotari d8294ad
[improve][misc] Document Pulsar security model scope (trusted functio…
lhotari c78df01
[improve][misc] Reword DoS phrasing in security model scope
lhotari d410011
[improve][misc] Link slog to its repository on mentions in agent docs
lhotari 728c326
[improve][misc] Require PMC go-ahead before pushing non-public securi…
lhotari 0d514a0
[improve][misc] Clarify project team commits security fixes; reporter…
lhotari 1426a19
[improve][misc] Clarify how the project team commits security fixes (…
lhotari d6c1316
[improve][misc] Add GitHub Discussions to Where to ask
lhotari 1fb8d30
[improve][misc] Document Pulsar concurrency model, JMM rules, and per…
lhotari a33c57c
[improve][misc] Clarify no explicit protection against malicious DoS
lhotari af13258
[improve][misc] Prefer named Java records over Pair returns and conca…
lhotari 8182e03
[improve][misc] Document /pulsarbot rerun for flaky CI and the fork-P…
lhotari 9934370
[improve][misc] Note /pulsarbot rerun requires the previous run's job…
lhotari 75f2d87
[improve][misc] Expand agent/contributor docs with conventions mined …
lhotari 3dcff2d
[improve][misc] Slim down .agents skills and refine backport guidance
lhotari 923448d
[improve][misc] Add licensing & provenance (human-in-the-loop) guidan…
lhotari 8ab032a
[improve][misc] Require human verification for security reports in SE…
lhotari 3b283e5
[improve][misc] Dedupe README into the split docs; point security lin…
lhotari 012afc3
[improve][misc] Note pulsar-site as the source of the project documen…
lhotari 205ea6a
[improve][misc] Refine SECURITY.md disclosure hygiene and drop deprec…
lhotari 9f58c04
[improve][misc] ARCHITECTURE.md: Oxia/ZooKeeper metadata store, link …
lhotari 663e12f
[improve][misc] Move SECURITY.md security model section near the end …
lhotari 5db4d01
[improve][misc] Clarify security PR rules: undisclosed-vuln fixes (in…
lhotari a889b54
[improve][misc] Add BUILDING.md and per-path Copilot instructions; co…
lhotari 2a5d284
[improve][misc] BUILDING.md: de-duplicate the Gradle best-practices link
lhotari bc18df2
[improve][misc] Refine AGENTS.md/ARCHITECTURE.md wording and section …
lhotari 79505bf
[improve][misc] BUILDING.md: broaden the CONTRIBUTING.md reference to…
lhotari 4ff3fa3
[improve][misc] Reorder CODING.md (logging/testing first, concurrency…
lhotari cdf4632
[improve][misc] Remove BUILDING.md; building -> CONTRIBUTING.md, buil…
lhotari a06b8f4
[improve][misc] Refine CODING.md method-naming and general recommenda…
lhotari ca5154e
[improve][misc] Clarify DEBUG vs TRACE log level guidance in CODING.md
lhotari b63b2e6
[improve][misc] Fix SECURITY.md: private@ list is a CC to security@ap…
lhotari 7029b26
[improve][misc] Soften SECURITY.md wording on RCE reports and trim se…
lhotari e8c836a
[improve][misc] Add do/don't code examples for key conventions in COD…
lhotari c66bc52
[improve][misc] Add concurrency-limiting / backpressure guidance to C…
lhotari File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ../AGENTS.md |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| --- | ||
| description: Conventions for changing Apache Pulsar's Gradle build (build scripts, version catalog, convention plugins). | ||
| applyTo: "**/*.gradle.kts,**/gradle.properties,gradle/libs.versions.toml,build-logic/**" | ||
| --- | ||
|
|
||
| # Gradle build changes | ||
|
|
||
| These files configure Apache Pulsar's **Gradle** build. Follow the guidance in | ||
| [`ARCHITECTURE.md` → Changing the build](../../ARCHITECTURE.md#changing-the-build) (and the | ||
| surrounding *Build infrastructure* section) when editing or reviewing a build file. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| --- | ||
| description: Coding conventions for Apache Pulsar Java source and test code. | ||
| applyTo: "**/*.java" | ||
| --- | ||
|
|
||
| # Java code changes | ||
|
|
||
| Apache Pulsar is performance-critical, asynchronous, and concurrency-sensitive. The full reference is | ||
| [`CODING.md`](../../CODING.md) (with [`CONTRIBUTING.md`](../../CONTRIBUTING.md) for running tests) — | ||
| follow it when editing or reviewing Java code. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.