Add /pr-artifact-explain Claude Code skill#862
Conversation
Signed-off-by: Ranran Haoran Zhang <ranzhang@redhat.com>
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughChangesPR Artifact Explain skill
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Merge Protections🔴 1 of 1 protections blocking · waiting on 👀 reviews
🔴 Require approval from approved reviewers listWaiting for any of
This rule is failing.All pull requests must have at least one approving review from a member of the approved reviewers list before merging.
|
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.claude/skills/pr-artifact-explain/SKILL.md:
- Line 4: Restrict the allowed-tools declaration in the pr-artifact-explain
skill to enforce its read-only contract at the tool boundary: replace
unrestricted Bash(gh api:*) with an allowlisted GET/list-only wrapper or
equivalent, and constrain Write to the artifact scratchpad location. Update the
tool configuration before relying on the prose-only restrictions, while
preserving the existing read-only gh and git operations.
- Line 35: Update the inline review-comment projection in the PR artifact
explanation to preserve review-thread, ownership, timestamp, and
revision/applicability metadata: include id, pull_request_review_id,
in_reply_to_id, created_at, commit_id, original_commit_id, path, line,
original_line, start_line, side, body, and user:.user.login. Keep the existing
paginated gh api retrieval behavior unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: af2b304e-0abf-473d-83bd-e51c8e03a86d
📒 Files selected for processing (1)
.claude/skills/pr-artifact-explain/SKILL.md
Pair each concern with its reply via in_reply_to_id instead of inferring threading from a shared file and line, and carry commit_id so a comment against a superseded revision is not reported as unaddressed. Signed-off-by: Ranran Haoran Zhang <ranzhang@redhat.com>
speculatorsbot
left a comment
There was a problem hiding this comment.
The design is sound — a single-file, 87-line skill that complements /pr-review by explaining rather than judging. The motivation is well-articulated, the data-fetching strategy is correct (including the paginated inline-comments fix in aed1bbc with id/in_reply_to_id/commit_id for proper thread reconstruction), and the read-only constraints are sensible.
One concern: step 4 depends on an artifact-design skill that does not appear to exist in this repository.
🤖 Generated with Claude Code using the /pr-review skill
|
|
||
| ### 4. Build the artifact | ||
|
|
||
| 1. Invoke the `artifact-design` skill first. |
There was a problem hiding this comment.
artifact-design is not present in this repository's .claude/skills/ directory and does not appear among Claude Code's built-in skills. If this is a user-level skill specific to your environment, other contributors running /pr-artifact-explain will hit a failure at this step.
Should artifact-design be added to the repo alongside this PR, or is there a fallback if it is unavailable?
Purpose
Adds a Claude Code skill,
/pr-artifact-explain, that a reviewer runs on a PR they've been asked to review. It reads the diff and the surrounding code and publishes a single html page explaining what the change does and why.The goal is to cut reviewer burden. It helps most where reviewing is most expensive:
Complements
/pr-review(#756): that one judges a PR, this one explains it. It is also usable for onboarding, but the intended reader is a maintainer doing a review.Not automated
Triggered manually by a reviewer, one PR at a time. The output is a private page the reviewer decides whether to share.
Example:
Test plan
/pr-artifact-explain 841on the config-file-first CLI PR — citations spot-checked against the merged commitpython -m mdformat --checkclean (make qualitycovers.claude/**/*.md)Checklist