UseDocumentation Index
Fetch the complete documentation index at: https://factory-docs-academy-content-candidates.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
/review when you want Droid to inspect local code changes before you commit, push, or open a pull request. The command opens an interactive workflow for reviewing a branch diff, uncommitted work, a specific commit, or custom review instructions.
/review is designed for local CLI sessions. For automated pull request reviews in CI, use the Automated Code Review guide.
Quick start
Choose what to review
Select one of the review types: base branch, uncommitted changes, commit, or custom instructions.
Configure the target
Choose the base branch, commit, or custom instructions requested by the selected review type.
Review types
Review against a base branch
Use a base branch review when you want PR-style feedback before you open or update a pull request.Review uncommitted changes
Use an uncommitted review for work in progress. Droid analyzes staged files, unstaged modifications, and untracked files in the current working tree.Review a commit
Use a commit review when you want to inspect one commit from repository history.Custom review instructions
Use custom instructions for targeted checks such as security, performance, migration safety, or team-specific conventions.What Droid reviews
Droid focuses on high-confidence, actionable bugs rather than stylistic preferences. It looks for issues such as:- Runtime failures, broken control flow, and incorrect variable usage
- Null or undefined dereferences
- Missing error handling for critical operations
- Resource leaks and unsafe async patterns
- Injection vulnerabilities, exposed secrets, and authentication or authorization bugs
- Breaking API, schema, serialization, or contract changes
- Dead or unreachable production code introduced by the change
Severity levels
Findings use priority labels so you can triage quickly:| Priority | Meaning |
|---|---|
| [P0] | Blocking issue: likely crash, exploit, data loss, or release blocker |
| [P1] | High-confidence correctness or security issue that should be fixed soon |
| [P2] | Plausible bug with a realistic trigger path but lower certainty or impact |
| [P3] | Minor but real bug |
Output format
Local/review output is a structured summary. Each finding includes a priority, file and line when available, and a concise description of the failure mode. If there are no findings, Droid returns a short LGTM message.
Tips
- Use base branch reviews before opening a pull request.
- Review smaller uncommitted diffs during active development.
- Add custom instructions for security, migrations, payments, authentication, or other high-risk surfaces.
Local review versus automated review
| Workflow | Best for | Setup |
|---|---|---|
/review | Local, interactive pre-commit or pre-PR checks | Run from a Droid CLI session |
| Automated code review | Automated GitHub or GitLab PR/MR review | Run /install-code-review |
| Droid Exec in CI | Custom CI automation and repository maintenance | Write a GitHub Actions workflow |
