docs(code-review): fix skill naming to avoid plugin override conflict#467
Merged
Conversation
The customization section previously instructed users to name their skill 'code-review', which conflicts with the pr-review plugin's built-in skill of the same name. Plugin skills forcibly override project skills with matching names, silently discarding the user's custom review guidelines. Changes: - Rename example from 'code-review' to 'custom-codereview-guide' (matching the pattern used by software-agent-sdk itself) - Add a Warning callout explaining the naming constraint - Update the reference link to point to the SDK's actual skill file Co-authored-by: openhands <openhands@all-hands.dev>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
all-hands-bot
approved these changes
Apr 21, 2026
Contributor
all-hands-bot
left a comment
There was a problem hiding this comment.
🟢 Good taste - Clean fix for a real production issue. The rename avoids the plugin override conflict, the warning is clear and well-placed, and the evidence in the PR description proves the problem exists.
[RISK ASSESSMENT]
- [Overall PR]
⚠️ Risk Assessment: 🟢 LOW - Documentation-only change that fixes a user-facing bug where custom review guidelines were silently discarded. No code changes, no behavioral changes to the product itself.
VERDICT:
✅ Worth merging: Solves a real problem with the simplest possible fix.
KEY INSIGHT:
Pragmatic workaround for a plugin loading issue - teaching users to avoid the conflict is better than leaving them confused when their custom skills disappear.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The Customization section currently instructs users to create a skill file named
code-reviewwithname: code-review:However, the pr-review plugin ships its own
code-reviewskill (symlinked fromextensions/skills/code-review). During plugin loading, plugin skills forcibly override project skills with the same name:This means the user's custom review guidelines are silently discarded, and the plugin's default English skill takes effect instead.
Evidence
Observed in CI logs from a real workflow run:
Fix
code-reviewtocustom-codereview-guide— matching the pattern used by software-agent-sdk itself<Warning>callout explaining the naming constraintcustom-codereview-guide.md, not the non-existentcode-review.md)With a different name, both skills coexist and activate on the
/codereviewtrigger:code-review→ provides the review format and frameworkcustom-codereview-guide→ adds repo-specific rulesNote
The underlying issue is that plugin skill loading doesn't respect explicitly loaded project skills — arguably a bug in the SDK's plugin system. This docs fix is the pragmatic workaround that works today.
This PR was created by an AI assistant (OpenHands) on behalf of the user.
@xingyaoww can click here to continue refining the PR