Skip to content

Add /pr-artifact-explain Claude Code skill#862

Open
WindChimeRan wants to merge 2 commits into
vllm-project:mainfrom
WindChimeRan:add-pr-artifact-explain-skill
Open

Add /pr-artifact-explain Claude Code skill#862
WindChimeRan wants to merge 2 commits into
vllm-project:mainfrom
WindChimeRan:add-pr-artifact-explain-skill

Conversation

@WindChimeRan

@WindChimeRan WindChimeRan commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

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:

  • The description is thin, confusing, or doesn't match the diff. The explanation is built from the source at the PR's own revision, so a weak description doesn't propagate into the review.
  • The PR is in an area you don't own. Ramp-up is usually the bulk of the work; this front-loads it.
  • The thread is long and you're joining late. Review discussion is condensed into one concern → response → outcome table.

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 841 on the config-file-first CLI PR — citations spot-checked against the merged commit
  • python -m mdformat --check clean (make quality covers .claude/**/*.md)
  • Run against an open PR with an active review thread

Checklist

  • The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
  • The test plan/results, such as providing test command and pasting the results.
  • (Optional) The necessary documentation update.
  • I (a human) have written or reviewed the code in this pr to the best of my ability.

Signed-off-by: Ranran Haoran Zhang <ranzhang@redhat.com>
@coderabbitai

coderabbitai Bot commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 59814b80-c3c5-4529-9f70-4d8e2337b07d

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Changes

PR Artifact Explain skill

Layer / File(s) Summary
Skill contract and grounding rules
.claude/skills/pr-artifact-explain/SKILL.md
Adds metadata, permitted tools, read-only constraints, source-grounding rules, citations, and inference handling for standalone PR explanations.
Pull request analysis workflow
.claude/skills/pr-artifact-explain/SKILL.md
Defines PR resolution, paginated GitHub data retrieval, head-revision inspection, external-reference handling, fallback behavior, and review-arc reconstruction.
Artifact construction and response
.claude/skills/pr-artifact-explain/SKILL.md
Defines artifact-design invocation, HTML publication requirements, structured artifact sections, and the brief follow-up response with the artifact link.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
Title check ✅ Passed The title clearly and concisely describes the main change: adding the /pr-artifact-explain Claude Code skill.
Description check ✅ Passed The description is directly related to the PR and explains the new skill, its purpose, and test plan.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

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

@mergify

mergify Bot commented Jul 25, 2026

Copy link
Copy Markdown

Merge Protections

🔴 1 of 1 protections blocking · waiting on 👀 reviews

Protection Waiting on
🔴 Require approval from approved reviewers list 👀 reviews

🔴 Require approval from approved reviewers list

Waiting for any of

  • approved-reviews-by = dsikka
  • approved-reviews-by = fynnsu
  • approved-reviews-by = orestis-z
  • approved-reviews-by = rahul-tuli
  • approved-reviews-by = shanjiaz
This rule is failing.

All pull requests must have at least one approving review from a member of the approved reviewers list before merging.

  • any of:
    • approved-reviews-by = dsikka
    • approved-reviews-by = fynnsu
    • approved-reviews-by = orestis-z
    • approved-reviews-by = rahul-tuli
    • approved-reviews-by = shanjiaz

@WindChimeRan
WindChimeRan marked this pull request as ready for review July 25, 2026 19:09

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 60cd983 and a21f462.

📒 Files selected for processing (1)
  • .claude/skills/pr-artifact-explain/SKILL.md

Comment thread .claude/skills/pr-artifact-explain/SKILL.md
Comment thread .claude/skills/pr-artifact-explain/SKILL.md Outdated
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>

@dsikka dsikka left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@speculatorsbot speculatorsbot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

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.

3 participants