docs: Add documentation for customizing code review via skills#306
Closed
docs: Add documentation for customizing code review via skills#306
Conversation
Document that users can customize the code review behavior by adding .openhands/skills/code-review.md to their repository instead of forking the agent_script.py. This is the recommended approach for customization. Changes to pr-review.mdx: - Add 'Customizing the Code Review' section with how-to guide - Include example custom skill with frontmatter and guidelines - List benefits of using custom skills over forking - Reference the software-agent-sdk's own code-review skill as example - Update reference workflow to use the new composite action - Add Action Inputs table documenting all available inputs - Add link to composite action in Related Files section - Add 'Customizable' feature to Features list Co-authored-by: openhands <openhands@all-hands.dev>
Merged
5 tasks
|
Looks like there are a few issues preventing this PR from being merged!
If you'd like me to help, just leave a comment, like Feel free to include any additional details that might help me get this PR into a better state. You can manage your notification settings |
2 tasks
xingyaoww
pushed a commit
that referenced
this pull request
Feb 8, 2026
…site action - Add 'Customizable' feature to Features section - Add new 'Customizing the Code Review' section with: - How custom skills work - Example custom code review skill - Benefits of custom skills - Update Reference Workflow to use simplified composite action - Add Action Inputs table documenting all available inputs - Add link to Composite Action in Related Files Co-authored-by: openhands <openhands@all-hands.dev>
xingyaoww
pushed a commit
that referenced
this pull request
Feb 8, 2026
…site action - Add 'Customizable' feature to Features section - Add new 'Customizing the Code Review' section with: - How custom skills work - Example custom code review skill - Benefits of custom skills - Update Reference Workflow to use simplified composite action - Add Action Inputs table documenting all available inputs - Add link to Composite Action in Related Files Co-authored-by: openhands <openhands@all-hands.dev>
xingyaoww
added a commit
that referenced
this pull request
Feb 8, 2026
* Initial layout This is an initial layout that roughly mimics Devin docs. It attempts to separate Documentation and Use Cases. * Added content to TODO pages. * Update Use Cases documentation pages - incident-triage.mdx: Add content based on Datadog debugging blog post - Features automated error analysis with OpenHands SDK - Includes GitHub Actions workflow for Datadog integration - Links to blog: https://openhands.dev/blog/debugging-production-issues-with-ai-agents-automating-datadog-error-analysis - cobol-modernization.mdx: Add content based on COBOL-to-Java refactoring blog post - Features iterative refinement approach with multiple agents - Includes code transformation examples (COBOL to Java) - Links to blog: https://openhands.dev/blog/20251218-cobol-to-java-refactoring - vulnerability-remediation.mdx: Add content based on vulnerability fixer documentation - Explains automated vulnerability remediation with AI agents - Links to example implementation at github.com/OpenHands/vulnerability-fixer - Covers integration with security scanners (Snyk, Dependabot, CodeQL) - dependency-upgrades.mdx: Remove redundant security scanning section - Links to Vulnerability Remediation page for security-related upgrades - Focuses on general dependency upgrade workflows Co-authored-by: openhands <openhands@all-hands.dev> * Update Tutorial Library page - Rename from 'TODO-Tutorial Library' to 'Tutorial Library' - Remove 'Getting Started with Tutorials' section - Add Note linking to Use Cases section for in-depth guidance - Add Code Review cross-references: - Link to Code Review Use Case page - Link to PR Review SDK Guide (sdk/guides/github-workflows/pr-review) - Add Bug Fixing cross-reference to Incident Triage Use Case Co-authored-by: openhands <openhands@all-hands.dev> * Redesign Quick Start page with cards Replace tabs-based layout with a card-based design: - OpenHands Cloud (recommended) - links to https://app.all-hands.dev - Local GUI - links to /openhands/usage/run-openhands/local-setup - Terminal / CLI - links to /openhands/usage/cli/installation Each card includes relevant icons and bullet points highlighting key features. Co-authored-by: openhands <openhands@all-hands.dev> * docs: Update code review documentation with PR review workflow - Rewrite code-review.mdx to document the automated PR review workflow - Explain how the workflow uses the Software Agent SDK with /codereview and /github-pr-review skills - Add Quick Start guide with step-by-step setup instructions - Document customization options including repo-specific review guidelines - Add security considerations and troubleshooting sections - Remove TODO- prefix from title Closes #297 * minor deletions, overview rework * re-organize sections to match flow * understanding section rewrite * scaling up moved, rewritten * validation restructure * tranlsation rewrite * docs: Update code review docs to use new composite GitHub Action Update the code review documentation to reflect the new composite GitHub Action from software-agent-sdk PR #1927. The changes include: - Simplified Quick Start workflow using the composite action - Added new 'Composite Action' section with action inputs table - Updated Customization section to show input-based configuration - Removed manual setup steps (Python, uv, dependencies) that are now handled by the composite action Co-authored-by: openhands <openhands@all-hands.dev> * fix: Remove broken link to non-existent security page Co-authored-by: openhands <openhands@all-hands.dev> * docs: Bring changes from PR #306 - customizable code review and composite action - Add 'Customizable' feature to Features section - Add new 'Customizing the Code Review' section with: - How custom skills work - Example custom code review skill - Benefits of custom skills - Update Reference Workflow to use simplified composite action - Add Action Inputs table documenting all available inputs - Add link to Composite Action in Related Files Co-authored-by: openhands <openhands@all-hands.dev> * docs: Add composite action link and SDK skill example reference to code-review.mdx - Add link to Composite Action in Related Resources section - Add reference to software-agent-sdk's code-review skill as example Co-authored-by: openhands <openhands@all-hands.dev> * docs: Link skills to OpenHands/skills repo in code-review.mdx - Add links to /codereview skill in OpenHands/skills repo - Add links to /codereview-roasted skill in OpenHands/skills repo - Add links to /github-pr-review skill in OpenHands/skills repo Co-authored-by: openhands <openhands@all-hands.dev> * docs: Mark llm-model as required in Action Inputs table Co-authored-by: openhands <openhands@all-hands.dev> * docs: Replace 'What Gets Reviewed' with real example PR reviews - Remove generic 'What Gets Reviewed' section with tabs - Replace 'Example Review Output' with table of real PR examples from software-agent-sdk - Link to PRs #1927, #1916, #1904, #1889 showing different review styles Co-authored-by: openhands <openhands@all-hands.dev> * docs: Link directly to review comments instead of PR pages Co-authored-by: openhands <openhands@all-hands.dev> * docs: Add security warning about API key exfiltration risk from fork PRs - Add 'API Key Protection' subsection explaining the potential risk - Document how SDK secrets mitigate the risk - Add best practices: review PRs first, use separate API keys, monitor usage - Link to SDK secrets documentation Co-authored-by: openhands <openhands@all-hands.dev> * docs: Simplify security considerations section - Summarize pull_request_target usage in one sentence - Keep warning about API key exfiltration risk concise - Remove prescriptive best practices list Co-authored-by: openhands <openhands@all-hands.dev> * Update sdk/guides/github-workflows/pr-review.mdx Co-authored-by: Engel Nyst <engel.nyst@gmail.com> * Update openhands/usage/use-cases/code-review.mdx Co-authored-by: Engel Nyst <engel.nyst@gmail.com> * Update openhands/usage/use-cases/code-review.mdx Co-authored-by: Engel Nyst <engel.nyst@gmail.com> --------- Co-authored-by: jpelletier1 <44589723+jpelletier1@users.noreply.github.com> Co-authored-by: openhands <openhands@all-hands.dev> Co-authored-by: Calvin Smith <calvin@all-hands.dev> Co-authored-by: Engel Nyst <engel.nyst@gmail.com>
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
2 participants
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
This PR adds documentation for customizing the PR review behavior by adding a
.openhands/skills/code-review.mdfile to your repository instead of forking theagent_script.py. This is the recommended approach for customization.Changes to pr-review.mdx
Related PR
This documentation update accompanies the composite GitHub Action changes in:
Benefits of Custom Skills
@xingyaoww can click here to continue refining the PR