Skip to content

Commit e665a18

Browse files
committed
Update AGENTS.md with upstream tracking requirements
- Added clarification that the API must not deviate from upstream jdk.sandbox repo - Documented that bugs in main logic must be fixed upstream, not in this repo - Only backporting machinery bugs may be fixed locally
1 parent 150e69e commit e665a18

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

AGENTS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,11 +117,15 @@ mvn exec:java -pl json-compatibility-suite -Dexec.args="--json"
117117
- `JsonBoolean`: JSON booleans.
118118
- `JsonNull`: JSON null.
119119

120+
IMPORTANT: This API **MUST NOT** deviate from the upstream jdk.sandbox repo which is will track.
121+
120122
#### Internal Implementation (`jdk.sandbox.internal.util.json`)
121123
- `JsonParser`: Recursive descent JSON parser.
122124
- `Json*Impl`: Immutable implementations of `Json*` types.
123125
- `Utils`: Internal utilities and factory methods.
124126

127+
IMPORTANT: Bugs in the main logic this code cannot be fixed in this repo they **MUST** be fixed upstream. Only bugs in any backporting machinery such as the double-check-locking class that is a polyfill for a future JDK `@StableValue` feature may be fixed in this repo.
128+
125129
### Design Patterns
126130
- Algebraic Data Types: Sealed interfaces enable exhaustive pattern matching.
127131
- Immutable Value Objects: All types remain immutable and thread-safe.

0 commit comments

Comments
 (0)