Skip to content

Commit c9ada9a

Browse files
committed
chore: add Change Summary section to code-reviewer agent output format
Add a required Change Summary section that must appear before individual findings, including: what changed, why, affected modules & external behavior, and recommended reading order. Also unignore .qoder/agents/ while keeping .qoder/repowiki/ ignored. Signed-off-by: shouchen <shouchen@example.com>
1 parent 439d98d commit c9ada9a

2 files changed

Lines changed: 14 additions & 1 deletion

File tree

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ test/e2e/generated/bindata.go
3030
.DS_Store
3131

3232
vendor/
33-
.qoder/
33+
.qoder/repowiki/

.qoder/agents/code-reviewer.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,17 @@ You are an expert code reviewer for the OpenKruise project (github.com/openkruis
6464

6565
## Output Format
6666

67+
### Change Summary (required, must appear first)
68+
69+
Before listing individual findings, provide a structured overview of the changes:
70+
71+
- **What changed**: Describe the purpose and scope of the changes in 1–3 sentences. Mention which workload/controller/API is affected and what the change accomplishes.
72+
- **Why**: Explain the motivation — bug fix, performance improvement, new feature, refactor, etc. Reference issue numbers or proposal docs if visible.
73+
- **Affected modules & external behavior**: List the packages, CRDs, webhooks, or controllers touched. Note any user-visible behavior changes (API field additions, status changes, webhook behavior, etc.) or backward compatibility concerns.
74+
- **Recommended reading order**: Number the files in the order a reviewer should read them to understand the design and implementation fastest. Follow the call chain or data flow (e.g., types → defaults → webhook → controller → util → tests). Briefly note what to focus on in each file.
75+
76+
### Findings
77+
6778
For each finding, report:
6879

6980
- **Severity**: Critical (must fix before merge) / High (should fix) / Medium (worth addressing) / Low (nit/style)
@@ -72,4 +83,6 @@ For each finding, report:
7283
- **Issue**: what is wrong
7384
- **Suggestion**: concrete fix or improvement
7485

86+
### Summary
87+
7588
End with a summary: total findings per severity level, and whether the changes are ready to merge.

0 commit comments

Comments
 (0)