merve's picture
|
download
raw
2.47 kB
# Review Output Template
Use this as the structure for PR review summary comments. Copy and fill in the sections.
## For PR Summary Comment
```markdown
## Code Review Summary
**Verdict: [Approved โœ… | Changes Requested ๐Ÿ”ด | Reviewed ๐Ÿ’ฌ]** ([N] issues, [N] suggestions)
**PR:** #[number] โ€” [title]
**Author:** @[username]
**Files changed:** [N] (+[additions] -[deletions])
### ๐Ÿ”ด Critical
<!-- Issues that MUST be fixed before merge -->
- **file.py:line** โ€” [description]. Suggestion: [fix].
### โš ๏ธ Warnings
<!-- Issues that SHOULD be fixed, but not strictly blocking -->
- **file.py:line** โ€” [description].
### ๐Ÿ’ก Suggestions
<!-- Non-blocking improvements, style preferences, future considerations -->
- **file.py:line** โ€” [description].
### โœ… Looks Good
<!-- Call out things done well โ€” positive reinforcement -->
- [aspect that was done well]
---
*Reviewed by Hermes Agent*
```
## Severity Guide
| Level | Icon | When to use | Blocks merge? |
|-------|------|-------------|---------------|
| Critical | ๐Ÿ”ด | Security vulnerabilities, data loss risk, crashes, broken core functionality | Yes |
| Warning | โš ๏ธ | Bugs in non-critical paths, missing error handling, missing tests for new code | Usually yes |
| Suggestion | ๐Ÿ’ก | Style improvements, refactoring ideas, performance hints, documentation gaps | No |
| Looks Good | โœ… | Clean patterns, good test coverage, clear naming, smart design decisions | N/A |
## Verdict Decision
- **Approved โœ…** โ€” Zero critical/warning items. Only suggestions or all clear.
- **Changes Requested ๐Ÿ”ด** โ€” Any critical or warning item exists.
- **Reviewed ๐Ÿ’ฌ** โ€” Observations only (draft PRs, uncertain findings, informational).
## For Inline Comments
Prefix inline comments with the severity icon so they're scannable:
```
๐Ÿ”ด **Critical:** User input passed directly to SQL query โ€” use parameterized queries to prevent injection.
```
```
โš ๏ธ **Warning:** This error is silently swallowed. At minimum, log it.
```
```
๐Ÿ’ก **Suggestion:** This could be simplified with a dict comprehension:
`{k: v for k, v in items if v is not None}`
```
```
โœ… **Nice:** Good use of context manager here โ€” ensures cleanup on exceptions.
```
## For Local (Pre-Push) Review
When reviewing locally before push, use the same structure but present it as a message to the user instead of a PR comment. Skip the PR metadata header and just start with the severity sections.

Xet Storage Details

Size:
2.47 kB
ยท
Xet hash:
d85ece3b7709af31842236836bae34abc6ab659f1d9d7afe30a7c6ec3c3cb37e

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.