-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Add GitHub response placement guidance to receiving-code-review #79
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add GitHub response placement guidance to receiving-code-review #79
Conversation
|
Warning Rate limit exceeded@ralphbean has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 54 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughAdded documentation for the receiving-code-review skill covering how to post responses on GitHub. New content distinguishes between replying to specific review threads versus general PR discussions, provides CLI command examples, and includes test documentation outlining validation scenarios for correct response placement behavior. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (1)
skills/receiving-code-review/SKILL.md (1)
102-111: Add language specification to decision tree code block.The GitHub API endpoint for replying to review comments is
/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies, which the instructions correctly show. However, the code block lacks a language identifier for proper rendering.-``` +```yaml WHEN responding to code review feedback on GitHub: IF feedback is from a specific review comment thread:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
skills/receiving-code-review/SKILL.md(1 hunks)skills/receiving-code-review/TEST-SCENARIO.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
skills/receiving-code-review/SKILL.md
102-102: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (1)
skills/receiving-code-review/SKILL.md (1)
115-139: ✅ Correct API guidance and clear examples.The endpoint path is accurate per GitHub's official API documentation. The decision tree, rationale, and "Common mistake" section effectively teach agents when and how to use threaded replies versus top-level comments. The contrast between the wrong (
gh pr comment) and right (gh api .../replies) approaches is particularly helpful.
skills/receiving-code-review/examples/github-placement-testing.md
Outdated
Show resolved
Hide resolved
The receiving-code-review skill previously lacked guidance on WHERE to post responses on GitHub, leading to agents posting top-level PR comments when they should reply in specific review comment threads. This commit adds: - Decision tree for threaded vs. top-level comments - Correct gh api command for threaded replies - Common mistakes section showing wrong approach 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> Signed-off-by: Ralph Bean <[email protected]>
726f348 to
4c20db1
Compare
|
Thanks for this. I see that you've got an example of the failure case. Do you have examples of it working right with the fix? |
No, not yet. |
|
My PR, which I just updated, handles some of this, and is slightly duplicative. If we like everything across both of these PRs, we should reconcile this a bit. #41 |
|
Thanks for this! We trimmed it down to the essential insight and added it in commit 0ca515a:
The rest of the gh CLI mechanics are things Claude already knows, but this threading guidance is a useful behavioral nudge. Credited you in the release notes! |
When replying to inline review comments, use the thread API rather than posting top-level PR comments. Based on feedback from @ralphbean in PR #79.
Summary
The receiving-code-review skill previously lacked guidance on WHERE to post responses on GitHub, leading to agents posting top-level PR comments when they should reply in specific review comment threads.
Changes
gh apicommand for threaded repliesReal-world failure case
PR konflux-ci/architecture#268 comment #3472979081 where an agent using this skill posted to the top-level PR instead of replying in the review thread.
Test plan
/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies🤖 Generated with Claude Code
Summary by CodeRabbit