Skip to content

Update docs for combined code-review skill #455

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
xingyaoww wants to merge 1 commit into from
Closed

Update docs for combined code-review skill #455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions openhands/usage/use-cases/code-review.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@
- The `review-this` label is added to a PR
- `openhands-agent` is requested as a reviewer

2. **Analysis**: The agent receives the complete PR diff and uses two skills:
- [**`/codereview`**](https://github.com/OpenHands/extensions/tree/main/skills/codereview) or [**`/codereview-roasted`**](https://github.com/OpenHands/extensions/tree/main/skills/codereview-roasted): Analyzes code for quality, security, and best practices
- [**`/github-pr-review`**](https://github.com/OpenHands/extensions/tree/main/skills/github-pr-review): Posts structured inline comments via the GitHub API
2. **Analysis**: The agent receives the complete PR diff and uses a code review skill:
- [**`/codereview`**](https://github.com/OpenHands/extensions/tree/main/skills/code-review): Analyzes code for quality, security, and best practices, and posts structured inline comments via the GitHub API
- [**`/codereview-roasted`**](https://github.com/OpenHands/extensions/tree/main/skills/codereview-roasted): Alternative Linus Torvalds-style brutally honest review

3. **Output**: Review comments are posted directly on the PR with:
- Priority labels (🔴 Critical, 🟠 Important, 🟡 Suggestion, 🟢 Nit)
Expand All @@ -47,7 +47,7 @@

| Style | Description | Best For |
|-------|-------------|----------|
| **Standard** ([`/codereview`](https://github.com/OpenHands/extensions/tree/main/skills/codereview)) | Pragmatic, constructive feedback focusing on code quality, security, and best practices | Day-to-day code reviews |
| **Standard** ([`/codereview`](https://github.com/OpenHands/extensions/tree/main/skills/code-review)) | Pragmatic, constructive feedback focusing on code quality, security, and best practices. Includes GitHub API posting instructions. | Day-to-day code reviews |
Copy link
Copy Markdown
Contributor

@all-hands-bot all-hands-bot Apr 14, 2026

Choose a reason for hiding this comment

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

🟡 Suggestion: The phrase "Includes GitHub API posting instructions." is an implementation detail that may confuse users. Both review styles will post to GitHub in practice (since the plugin loads both skill files), so this phrase suggests only the Standard style posts reviews, which isn't true.

Consider removing this phrase or rephrasing to clarify that all reviews are posted to GitHub regardless of style. The original description was already clear that it's a code review tool.

| **Roasted** ([`/codereview-roasted`](https://github.com/OpenHands/extensions/tree/main/skills/codereview-roasted)) | Linus Torvalds-style brutally honest review emphasizing "good taste", data structures, and simplicity | Critical code paths, learning opportunities |

## Quick Start
Expand Down Expand Up @@ -122,7 +122,7 @@
|-------|-------------|----------|---------|
| `llm-model` | LLM model to use | Yes | - |
| `llm-base-url` | LLM base URL (for custom endpoints) | No | `''` |
| `review-style` | Review style: `standard` or `roasted` | No | `roasted` |
| `review-style` | **[Deprecated]** Review style: `standard` or `roasted`. Both styles now use the combined `code-review` skill. | No | `roasted` |
Copy link
Copy Markdown
Contributor

@all-hands-bot all-hands-bot Apr 14, 2026

Choose a reason for hiding this comment

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

🟡 Suggestion: The deprecation message "Both styles now use the combined code-review skill" is technically confusing since the roasted style still uses the codereview-roasted skill file. What's actually changed is that GitHub API posting is now built into the workflow, making this parameter redundant.

Consider clarifying: "[Deprecated] GitHub API posting is now built into both review styles, making this parameter redundant." This better explains WHY it's deprecated.

| `extensions-version` | Git ref for extensions (tag, branch, or commit SHA) | No | `main` |
| `extensions-repo` | Extensions repository (owner/repo) | No | `OpenHands/extensions` |
| `llm-api-key` | LLM API key | Yes | - |
Expand Down Expand Up @@ -227,7 +227,7 @@
The workflow uses `pull_request_target` so the code review agent can work properly for PRs from forks. Only users with write access can trigger reviews via labels or reviewer requests.

<Warning>
**Potential Risk**: A malicious contributor could submit a PR from a fork containing code designed to exfiltrate your `LLM_API_KEY` when the review agent analyzes their code.

Check warning on line 230 in openhands/usage/use-cases/code-review.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/use-cases/code-review.mdx#L230 

Did you really mean 'exfiltrate'?

To mitigate this, the PR review workflow passes API keys as [SDK secrets](/sdk/guides/secrets) rather than environment variables, which prevents the agent from directly accessing these credentials during code execution.
</Warning>
Expand All @@ -241,7 +241,7 @@
| [#1927](https://github.com/OpenHands/software-agent-sdk/pull/1927#pullrequestreview-3767493657) | Composite GitHub Action refactor | Comprehensive review with 🔴 Critical, 🟠 Important, and 🟡 Suggestion labels |
| [#1916](https://github.com/OpenHands/software-agent-sdk/pull/1916#pullrequestreview-3758297071) | Add example for reconstructing messages | Critical issues flagged with clear explanations |
| [#1904](https://github.com/OpenHands/software-agent-sdk/pull/1904#pullrequestreview-3751821740) | Update code-review skill guidelines | APPROVED review highlighting key strengths |
| [#1889](https://github.com/OpenHands/software-agent-sdk/pull/1889#pullrequestreview-3747576245) | Fix tmux race condition | Technical review of concurrency fix with dual-lock strategy analysis |

Check warning on line 244 in openhands/usage/use-cases/code-review.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

openhands/usage/use-cases/code-review.mdx#L244 

Did you really mean 'tmux'?

## Troubleshooting

Expand Down
4 changes: 2 additions & 2 deletions sdk/guides/github-workflows/pr-review.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
```

<Note>
**Note**: These rules supplement the default `code-review` skill, not replace it.
**Note**: These rules supplement the default `code-review` skill, not replace it. The `code-review` skill now includes both review guidelines and instructions for posting inline comments via the GitHub API (previously the separate `github-pr-review` skill).
</Note>

<Tip>
Expand All @@ -104,7 +104,7 @@
2. **Version controlled**: Your review guidelines live in your repository
3. **Easy updates**: SDK updates don't overwrite your customizations
4. **Team alignment**: Everyone uses the same review standards
5. **Composable**: Add project-specific rules alongside default guidelines

Check warning on line 107 in sdk/guides/github-workflows/pr-review.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

sdk/guides/github-workflows/pr-review.mdx#L107 

Did you really mean 'Composable'?

<Note>
See the [software-agent-sdk's own custom-codereview-guide skill](https://github.com/OpenHands/software-agent-sdk/blob/main/.agents/skills/custom-codereview-guide.md) for a complete example.
Expand Down Expand Up @@ -181,7 +181,7 @@
|-------|-------------|----------|---------|
| `llm-model` | LLM model to use | Yes | - |
| `llm-base-url` | LLM base URL (optional) | No | `''` |
| `review-style` | Review style: 'standard' or 'roasted' | No | `roasted` |
| `review-style` | **[Deprecated]** Review style: `standard` or `roasted`. Both styles now use the combined `code-review` skill. | No | `roasted` |
| `extensions-version` | Git ref for extensions (tag, branch, or commit SHA) | No | `main` |
| `extensions-repo` | Extensions repository (owner/repo) | No | `OpenHands/extensions` |
| `llm-api-key` | LLM API key | Yes | - |
Expand Down
Loading