[infra] Add change-type review guides with runtime/ template#911
Open
weiqingy wants to merge 1 commit into
Open
[infra] Add change-type review guides with runtime/ template#911weiqingy wants to merge 1 commit into
weiqingy wants to merge 1 commit into
Conversation
Add a change-type review guide index to code_review.md, and the first per-type guide as a template: runtime/ state and recovery. Each guide narrows the full review passes to the concerns that matter most for one change type and links examples from past reviews, so the detail loads on demand and the main guide stays concise. The runtime/ guide draws its two examples from real review threads (apache#874, apache#880). Remaining change types are listed as planned and will follow one small PR each once this shape is settled. Exempt review-guides/ from Apache RAT, matching the existing AGENTS.md and code_review.md exemptions.
github-actions
Bot
added
doc-included
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
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.mdstays 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.mdgains 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.mdis the first fully-worked guide: a focused checklist for runtime state, serde, and recovery reviews, plus two examples drawn from real review threads ([runtime] Binary serde for MemoryUpdate values via versioned Kryo envelope #874 serde compatibility flag, [hotfix] Propagate action task Errors from mailbox #880 deterministic failure-path fixture).The remaining change types (
api/, Python-Java bridge,dist/dependency, docs-only) are listed asplannedand 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.shwith the change: RAT passes, confirmingreview-guides/is correctly excluded (a review-guide file has no place for a license header, matching the existingAGENTS.mdandcode_review.mdexemptions).API
No. No code or public API change.
Documentation
doc-included