Skip to content

Commit 931d872

Browse files
committed
Enhance review guidelines in claude-code-review.yml to require collapsible details and summary sections
1 parent ecb7689 commit 931d872

1 file changed

Lines changed: 27 additions & 5 deletions

File tree

.github/workflows/claude-code-review.yml

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,8 @@ jobs:
7575
CRITICAL: Do not post any "test" or "review in progress" comments. Only post your final review, deleting previous reviews.
7676
CRITICAL: NEVER post a link like "detailed review can be found at <url>". You MUST post the FULL review in the PR.
7777
CRITICAL: your review should have a summary section and capture details in a collapsable section so the default view is concise and to the point.
78+
CRITICAL: Your review MUST contain `<details>` and `<summary>` HTML tags to make the details collapsable.
79+
CRITICAL: Your review must detail how you arrived at your conclusions, especially the % scores you assigned.
7880
7981
Use these emoji to help convey your summary.
8082
✅ Something you checked that is correct, or something the code changes and does what it's supposed to
@@ -105,15 +107,24 @@ jobs:
105107
106108
Some examples:
107109
<details>
108-
<summary>This review looks great!
109-
![](badge1)
110-
![](badge2)
110+
<summary>
111+
### Code review summary
112+
![](badge1) ![](badge2) ![](badge3)
113+
114+
:+1: Overall, great work! This looks ready to merge to me!
111115
112116
✅ Thing I checked
113-
✅ Another thing I think is great</summary>
117+
✅ Another thing I think is great
118+
</summary>
114119
115120
Heres all the detail from my review that I would normally capture to cover the details
116121
requested for the review.
122+
123+
Extended details about what was looked into
124+
125+
Another aspect
126+
127+
## Headings of L2 or greater to separate sections.
117128
118129
</details>
119130
@@ -125,13 +136,24 @@ jobs:
125136
or if you think there's an issue with the changes...
126137
127138
<details>
128-
<summary>I think some things need changes. Check in the details for more info
139+
<summary>
140+
### Code review summary
141+
![](badge1) ![](badge2) ![](badge3)
142+
143+
❌ This PR does abc badly and needs to be corrected before it can be merged.
144+
129145
❔ I don't understand how <a specific part> works.
130146
⚠️ I think this the performance will be an issue
131147
❌ Your comments and PR descriptions suggest that you're trying to assign permissions to admins but it looks like you're actually assigning them to guests</summary>
132148
133149
Heres all the detail from my review that I would normally capture to cover the details
134150
requested for the review.
151+
152+
Extended details about what was looked into
153+
154+
Another aspect
155+
156+
## Headings of L2 or greater to separate sections.
135157
136158
</details>
137159

0 commit comments

Comments
 (0)