Skip to content

docs(code-review): fix skill naming to avoid plugin override conflict#467

Merged
xingyaoww merged 1 commit into
mainfrom
docs/fix-codereview-skill-naming
Apr 21, 2026
Merged

docs(code-review): fix skill naming to avoid plugin override conflict#467
xingyaoww merged 1 commit into
mainfrom
docs/fix-codereview-skill-naming

Conversation

@xingyaoww
Copy link
Copy Markdown
Member

Problem

The Customization section currently instructs users to create a skill file named code-review with name: code-review:

---
name: code-review
...

However, the pr-review plugin ships its own code-review skill (symlinked from extensions/skills/code-review). During plugin loading, plugin skills forcibly override project skills with the same name:

Plugin skill 'code-review' overrides existing skill

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:

Loaded 10 project skills: [..., 'code-review']              # ✅ project skill loaded
Skipping auto-loaded skill 'code-review' (already in explicit skills)  # ✅ public skill correctly skipped
Plugin skill 'code-review' overrides existing skill          # ❌ plugin overrides it

Fix

  • Rename the example skill 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 (custom-codereview-guide.md, not the non-existent code-review.md)

With a different name, both skills coexist and activate on the /codereview trigger:

  • Plugin's code-review → provides the review format and framework
  • Project's custom-codereview-guide → adds repo-specific rules

Note

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

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>
@mintlify
Copy link
Copy Markdown

mintlify Bot commented Apr 21, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
all-hands-ai 🟢 Ready View Preview Apr 21, 2026, 9:37 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@xingyaoww xingyaoww marked this pull request as ready for review April 21, 2026 21:40
@xingyaoww xingyaoww requested a review from mamoodi as a code owner April 21, 2026 21:40
Copy link
Copy Markdown
Contributor

@all-hands-bot all-hands-bot left a comment

Choose a reason for hiding this comment

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

🟢 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.

@xingyaoww xingyaoww merged commit b27f4e1 into main Apr 21, 2026
9 checks passed
@xingyaoww xingyaoww deleted the docs/fix-codereview-skill-naming branch April 21, 2026 21:44
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