weiqingy opened a new pull request, #911:
URL: https://github.com/apache/flink-agents/pull/911

   Linked issue: #894
   
   ### Purpose of change
   
   Item 2 of #894, in the shape agreed on the issue: split the worked examples 
into a per-change-type structure rather than a single appendix, so 
`code_review.md` stays a thin index and the detailed guidance for a change type 
loads only when an agent touches that kind of change.
   
   This first PR establishes the template:
   
   - `code_review.md` gains a **Change-Type Review Guides** index — a small 
matrix mapping each change type to its focused guide, used as an on-ramp before 
the full passes.
   - `review-guides/runtime-state-recovery.md` is the first fully-worked guide: 
a focused checklist for runtime state, serde, and recovery reviews, plus two 
examples drawn from real review threads (#874 serde compatibility flag, #880 
deterministic failure-path fixture).
   
   The remaining change types (`api/`, Python-Java bridge, `dist`/dependency, 
docs-only) are listed as `planned` and will follow one small PR each once this 
shape is settled, so the template can be reviewed before the rest are filled 
in. The examples come from actual human reviews per the issue discussion, and 
each links the specific review comment.
   
   ### Tests
   
   Not applicable — documentation only, no logic.
   
   Ran `./tools/check-license.sh` with the change: RAT passes, confirming 
`review-guides/` is correctly excluded (a review-guide file has no place for a 
license header, matching the existing `AGENTS.md` and `code_review.md` 
exemptions).
   
   ### API
   
   No. No code or public API change.
   
   ### Documentation
   
   - [x] `doc-included`
   


-- 
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]

Reply via email to