Skip to content

Clarify show changes review timing#48

Merged
Waishnav merged 2 commits into
mainfrom
refine-show-changes-instructions
Jun 30, 2026
Merged

Clarify show changes review timing#48
Waishnav merged 2 commits into
mainfrom
refine-show-changes-instructions

Conversation

@Waishnav

@Waishnav Waishnav commented Jun 30, 2026

Copy link
Copy Markdown
Owner

Summary: add show_changes timing guidance to Codex-mode instructions, clarify once-per-turn review behavior, and clarify last_shown vs workspace_open usage. Testing: not run; npm was blocked earlier and node_modules are unavailable in this worktree.

Summary by CodeRabbit

  • Bug Fixes
    • Improved change previews so show_changes is triggered exactly once per workspace after the final related edit/write in the current turn, avoiding repeated previews during the same update flow.
    • Clarified the workspace change viewing guidance, including how “since” behaves for end-of-turn review (with last_shown as the default) versus full review since workspace open.

@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: ccb2f2d5-0d41-4cf4-8520-ad1daf95f126

📥 Commits

Reviewing files that changed from the base of the PR and between 47c7bac and 28cf26f.

📒 Files selected for processing (1)
  • src/server.ts

📝 Walkthrough

Walkthrough

Updates src/server.ts to conditionally inject show_changes guidance into generated instructions and revises the tool description plus since parameter text to match the new one-time end-of-turn usage.

Changes

show_changes Guidance Update

Layer / File(s) Summary
Conditional show_changes instruction text
src/server.ts
serverInstructions() builds a showChangesInstruction string only when config.widgets === "changes" and inserts it into both codex and non-codex instruction templates.
show_changes tool description and since parameter wording
src/server.ts
The show_changes tool description now specifies calling it exactly once after the final successful edit/write/apply_patch action, and the since parameter text clarifies workspace_open and last_shown usage.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

A rabbit reads the prompt with glee,
“Show changes once” — that’s the key!
After edits done, then look and see,
No extra diffs from me or thee,
Hop hop, the instructions now agree 🐰

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: clarifying when show_changes should be called.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch refine-show-changes-instructions

Comment @coderabbitai help to get the list of available commands.

@Waishnav Waishnav merged commit 323d862 into main Jun 30, 2026
3 of 4 checks passed
@Waishnav Waishnav deleted the refine-show-changes-instructions branch June 30, 2026 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant