@xstly1014/code-review
v1.0.0
Published
A link-by-link, module-by-module deep code review Skill for TRAE. Identifies demo-level implementations and provides production-grade upgrade solutions.
Maintainers
Readme
Code Review Skill
A link-by-link, module-by-module deep code review Skill designed for TRAE. Identifies demo-level implementations and provides production-grade upgrade solutions.
Features
- Incremental Link-by-Link Review: No blanket scanning; reviews each link/module in depth one at a time
- Demo-Level Implementation Detection: Automatically identifies demo-level implementation patterns and provides production-grade alternatives
- Conversational Interaction: Informs users of issues through dialogue, providing solutions and reasoning for selection
- Complete Context Guarantee: Automatically traces upstream and downstream code, ensuring review conclusions are based on complete information
- Colorful Illustrated Documentation: Generates HTML reports with color architecture diagrams (supports Markdown fallback)
Frontend Focus Areas
UI, styles, layout, code conventions, code logic
Backend Focus Areas
Code correctness, code conventions, link closure, with additional focus on caching, concurrency, async, database, consistency, architecture, fault tolerance, technology selection, technical solutions
Installation
Clone this repository into TRAE's skills directory:
git clone https://github.com/Xstly1014/code-review.git .trae/skills/code-reviewOr manually place SKILL.md and related files into the .trae/skills/code-review/ directory.
Directory Structure
code-review/
├── SKILL.md # Main skill file (core specification)
├── README.md # This file
├── references/ # Reference documents
│ ├── frontend-checklist.md # Frontend review detailed checklist
│ ├── backend-checklist.md # Backend review detailed checklist
│ ├── demo-patterns.md # Demo-level implementation detection guide
│ └── pitfalls.md # Review caveats and common pitfalls
├── templates/ # Document templates
│ ├── review-report-html.template # HTML color illustrated report template
│ └── review-report-md.template # Markdown fallback report template
└── examples/ # ExamplesUsage
In TRAE, tell the AI:
- "Help me review the login link code"
- "Review the order service code"
- "Full-project code review"
- "Review the code quality of UserController.java"
Review Workflow
- Determine scope: Full-project / single-link / specified-file
- Obtain complete context: Automatically trace upstream and downstream code, ensuring information completeness
- Analyze and detect: File-by-file analysis, check against Demo pattern checklist
- Self-confirm: Confirm issues are real and solutions are executable
- Conversational notification: Point out issues through dialogue, provide upgrade solutions and reasoning
- Record documentation: Generate color illustrated HTML report
Document Output
- Default format: HTML (color architecture diagrams + interleaved text)
- Fallback format: Markdown
- Full-project review: categorized by link, each link as an independent document
- Single link/module review: save one document after completion
Core Philosophy
Review is easy, but avoiding mistakes during the review process is harder.
This Skill strictly defines 12 prohibitions and 18 common pitfalls, ensuring review conclusions are accurate and executable.
