From 2522844147da2f9e415f17a4bf1ce03932572390 Mon Sep 17 00:00:00 2001 From: openhands Date: Tue, 21 Apr 2026 21:34:45 +0000 Subject: [PATCH] docs(code-review): fix skill naming to avoid plugin override conflict 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/usage/use-cases/code-review.mdx | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/openhands/usage/use-cases/code-review.mdx b/openhands/usage/use-cases/code-review.mdx index 94c6ddc1..774b91e3 100644 --- a/openhands/usage/use-cases/code-review.mdx +++ b/openhands/usage/use-cases/code-review.mdx @@ -130,11 +130,11 @@ Use `extensions-version` to pin to a specific version tag (e.g., `v1.0.0`) for p ### Repository-Specific Review Guidelines -Create custom review guidelines for your repository by adding a skill file at `.agents/skills/code-review.md`: +Add repo-specific review rules by creating a skill file at `.agents/skills/custom-codereview-guide.md`: ```markdown --- -name: code-review +name: custom-codereview-guide description: Custom code review guidelines for this repository triggers: - /codereview @@ -174,8 +174,12 @@ You are reviewing code for [Your Project Name]. Follow these guidelines: - Tests should be in [your test directory] ``` + +**Do not** name your skill `code-review`. The pr-review plugin ships its own `code-review` skill, and plugin skills override project skills with the same name. Use a different name (e.g. `custom-codereview-guide`) with the `/codereview` trigger so both skills are active — the plugin provides the review framework while your skill adds repo-specific rules. + + -The skill file must use `/codereview` as the trigger to override the default review behavior. See the [software-agent-sdk's own code-review skill](https://github.com/OpenHands/software-agent-sdk/blob/main/.agents/skills/code-review.md) for a complete example. +The skill file must use `/codereview` as the trigger so it activates alongside the default review behavior. See the [software-agent-sdk's own custom-codereview-guide](https://github.com/OpenHands/software-agent-sdk/blob/main/.agents/skills/custom-codereview-guide.md) for a complete example. ### Workflow Configuration