Skip to content

Review comments enable detailed discussion on specific lines of code. Kizuna supports inline comments, threaded replies, and resolution tracking.

Types of Comments

General PR Comments

Top-level comments on the PR:

  • Overall feedback
  • Design questions
  • General discussion

Inline Comments

Comments on specific lines:

  • Point to exact code
  • Threaded replies
  • Suggest changes

Review Summary

Overall review decision:

  • Approve / Request Changes / Comment
  • Summary message

Adding Inline Comments

Via Web UI

  1. In PR Changes tab, hover over a line
  2. Click the + icon that appears
  3. Type your comment
  4. Click Add single comment or Start review

Comment Options

  • Add single comment: Immediate, visible to all
  • Start review: Batch multiple comments, submit together

Comment Features

  • Mention: @username to notify
  • Reference: #123 to link issues/PRs
  • Suggest changes: Propose code edits
  • Markdown: Format with Markdown

Suggesting Changes

Propose specific code modifications:

Click "Suggest changes" button

Shows:
```suggestion
function greet(name) {
  return `Hello, ${name}!`;
}

Author can apply suggestions directly:
- **Commit suggestion**: Apply single suggestion
- **Add to batch**: Apply multiple together

## Threaded Discussions

Comments support threaded replies:

Reviewer: "This might have race condition" ↓ Author: "Good catch — I'll add mutex" ↓ Reviewer: "Also check line 67" ↓ Author: [updates code, shows diff] ↓ Reviewer: "LGTM" + Resolve


## Resolving Comments

### Mark as Resolved

When issue is addressed:
1. Author updates code
2. Commenter or author clicks **Resolve**
3. Thread collapses
4. Shown as resolved in activity

### Unresolve

Reopen resolved threads:
- Click **Unresolve**
- Thread reappears
- Continue discussion

### Required Resolution

Branch protection can require:
- All comments resolved before merge
- Specific reviewer approval

## Confidence Annotations (Agent PRs)

Agent-authored changes include confidence markers:

🟢 High confidence — Standard pattern, well-tested 🟡 Medium confidence — Please review this section 🔴 Low confidence — Novel approach, needs human review


Focus review attention on low-confidence areas.

## Comment API

### Add Comment

```bash
curl -X POST /api/v1/repos/org/repo/pulls/42/comments \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
    "body": "Consider using async/await here",
    "path": "src/auth.ts",
    "line": 45,
    "side": "RIGHT"
  }'

Reply to Comment

bash
curl -X POST /api/v1/repos/org/repo/pulls/42/comments \
  -d '{
    "body": "Good point, updated",
    "in_reply_to": 12345
  }'

Resolve Comment

bash
curl -X POST /api/v1/comments/12345/resolve \
  -H "Authorization: Bearer $TOKEN"

List Comments

bash
curl /api/v1/repos/org/repo/pulls/42/comments

Best Practices

For Reviewers

  1. Be specific — "Line 23 has bug" not "This is wrong"
  2. Explain why — Help author understand
  3. Suggest fixes — Use suggestion feature
  4. Distinguish severity — Required vs. nice-to-have
  5. Be respectful — Constructive, not critical

For Authors

  1. Don't take personally — Code review, not person review
  2. Ask for clarification — If comment unclear
  3. Acknowledge quickly — Even if fix takes time
  4. Resolve when done — Keep PR clean
  5. Learn from feedback — Apply to future work

Comment Notifications

Reviewers are notified via:

  • Email (configurable)
  • Web UI notifications
  • WebSocket real-time (if connected)

Configure in SettingsNotifications:

  • PRs you're subscribed to
  • PRs where you're mentioned
  • PRs you authored

Summary

Review comments enable:

  • Precision — Point to exact code
  • Discussion — Threaded conversations
  • Actionability — Suggest specific changes
  • Resolution tracking — Know what's addressed

They're the primary mechanism for collaborative code improvement in Kizuna.