mirror of
https://github.com/alibaba/open-code-review.git
synced 2026-07-09 17:28:58 +00:00
1.6 KiB
1.6 KiB
/open-code-review
Invoke the professional code review Agent CLI tool OpenCodeReview (OCR) to review current code changes, and let the Agent autonomously decide whether to apply fixes.
Workflow
Step 1: Run Code Review
Run the OCR command:
ocr review --audience agent [user-args]
- Default (no user arguments): reviews staged, unstaged, and untracked changes (workspace mode).
- If the user provides
--commitor--c: pass through as-is. - If the user provides
--fromand--to: pass through as-is. - (Optional) Provide
--background "requirement context"to review whether the requirements are correctly implemented. - (Optional) Provide
--background-file ./requirements.mdto load the same context from a Markdown file (sanitised and limited to 8000 characters). Combined with--backgroundthe inline value is given first. - Capture full stdout. Set a 5-minute timeout.
- If the
ocrcommand is not found, install it by runningnpm i -g @alibaba-group/open-code-review.
Step 2: Filter and Evaluate
For each comment, assess its validity and quality:
- High: Obvious bugs, security issues, clear mistakes, or well-founded suggestions with precise fix proposals
- Medium: Reasonable concerns but context-dependent, style/performance suggestions, or fixes that require manual implementation
- Low: Likely false positives, lacking sufficient context, nitpicks, or meaningless suggestions
Silently discard low-confidence comments. Display the remaining comments.
Step 3: Fix
Automatically fix issues and suggestions that are worth adopting.