chore: Rename code-review.md to custom-codereview-guide.md#12922
Closed
chore: Rename code-review.md to custom-codereview-guide.md#12922
Conversation
Rename the repo-specific code review skill to use a unique name that won't conflict with the public code-review skill. This allows both the default public code review guidelines AND the repo-specific guidelines to be triggered by /codereview. Co-authored-by: openhands <openhands@all-hands.dev>
Contributor
Collaborator
all-hands-bot
left a comment
There was a problem hiding this comment.
The changes correctly add frontmatter to prevent name conflicts. However, the description may be misleading regarding whether this is a repo-specific or public skill.
| @@ -1,4 +1,6 @@ | |||
| --- | |||
| name: custom-codereview-guide | |||
| description: Repo-specific code review guidelines for OpenHands/OpenHands. Provides additional review rules alongside the default code review skill. | |||
Collaborator
There was a problem hiding this comment.
🟡 Suggestion: The description says "Repo-specific code review guidelines for OpenHands/OpenHands," but this file is located in skills/ which is the public/shareable skills directory (available to all OpenHands users).
According to the skills/README.md, repository-specific skills should be in .openhands/skills/ or .openhands/microagents/.
Options:
- If this is meant to be public/shareable: Update the description to something like "Code review guidelines for OpenHands projects" (remove "repo-specific")
- If this is meant to be repository-specific: Move it to
.openhands/skills/custom-codereview-guide.md
The skill content itself is generic enough to be public, so option 1 seems more appropriate.
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.
Summary
Rename the repo-specific code review skill to use a unique name that won't conflict with the public
code-reviewskill.Changes
skills/code-review.md→skills/custom-codereview-guide.mdname: custom-codereview-guidefield to the frontmatterWhy
With a skill named
code-review, it would completely override the default public code-review skill from OpenHands/extensions.By using a unique name (
custom-codereview-guide) with the same trigger (/codereview), both skills will now be activated:This gives reviewers the benefit of both general best practices AND repo-specific rules.
Related
@xingyaoww can click here to continue refining the PR
To run this PR locally, use the following command:
GUI with Docker: