code-reviewer
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseCode Reviewer
代码审查工具包
Complete toolkit for code reviewer with modern tools and best practices.
为代码审查者提供的集成现代工具与最佳实践的完整工具包。
Quick Start
快速开始
Main Capabilities
核心功能
This skill provides three core capabilities through automated scripts:
bash
undefined本技能通过自动化脚本提供三项核心功能:
bash
undefinedScript 1: Pr Analyzer
脚本1:PR分析器
python scripts/pr_analyzer.py [options]
python scripts/pr_analyzer.py [options]
Script 2: Code Quality Checker
脚本2:代码质量检查器
python scripts/code_quality_checker.py [options]
python scripts/code_quality_checker.py [options]
Script 3: Review Report Generator
脚本3:审查报告生成器
python scripts/review_report_generator.py [options]
undefinedpython scripts/review_report_generator.py [options]
undefinedCore Capabilities
核心功能详情
1. Pr Analyzer
1. PR分析器
Automated tool for pr analyzer tasks.
Features:
- Automated scaffolding
- Best practices built-in
- Configurable templates
- Quality checks
Usage:
bash
python scripts/pr_analyzer.py <project-path> [options]用于PR分析任务的自动化工具。
特性:
- 自动化脚手架
- 内置最佳实践
- 可配置模板
- 质量检查
用法:
bash
python scripts/pr_analyzer.py <project-path> [options]2. Code Quality Checker
2. 代码质量检查器
Comprehensive analysis and optimization tool.
Features:
- Deep analysis
- Performance metrics
- Recommendations
- Automated fixes
Usage:
bash
python scripts/code_quality_checker.py <target-path> [--verbose]综合分析与优化工具。
特性:
- 深度分析
- 性能指标
- 优化建议
- 自动化修复
用法:
bash
python scripts/code_quality_checker.py <target-path> [--verbose]3. Review Report Generator
3. 审查报告生成器
Advanced tooling for specialized tasks.
Features:
- Expert-level automation
- Custom configurations
- Integration ready
- Production-grade output
Usage:
bash
python scripts/review_report_generator.py [arguments] [options]用于特定任务的高级工具。
特性:
- 专家级自动化
- 自定义配置
- 可集成
- 生产级输出
用法:
bash
python scripts/review_report_generator.py [arguments] [options]Reference Documentation
参考文档
Code Review Checklist
代码审查清单
Comprehensive guide available in :
references/code_review_checklist.md- Detailed patterns and practices
- Code examples
- Best practices
- Anti-patterns to avoid
- Real-world scenarios
详细指南位于:
references/code_review_checklist.md- 详细的模式与实践
- 代码示例
- 最佳实践
- 需要避免的反模式
- 真实场景案例
Coding Standards
编码标准
Complete workflow documentation in :
references/coding_standards.md- Step-by-step processes
- Optimization strategies
- Tool integrations
- Performance tuning
- Troubleshooting guide
完整的工作流文档位于:
references/coding_standards.md- 分步流程
- 优化策略
- 工具集成
- 性能调优
- 故障排除指南
Common Antipatterns
常见反模式
Technical reference guide in :
references/common_antipatterns.md- Technology stack details
- Configuration examples
- Integration patterns
- Security considerations
- Scalability guidelines
技术参考指南位于:
references/common_antipatterns.md- 技术栈细节
- 配置示例
- 集成模式
- 安全注意事项
- 可扩展性指南
Tech Stack
技术栈
Languages: TypeScript, JavaScript, Python, Go, Swift, Kotlin
Frontend: React, Next.js, React Native, Flutter
Backend: Node.js, Express, GraphQL, REST APIs
Database: PostgreSQL, Prisma, NeonDB, Supabase
DevOps: Docker, Kubernetes, Terraform, GitHub Actions, CircleCI
Cloud: AWS, GCP, Azure
编程语言: TypeScript, JavaScript, Python, Go, Swift, Kotlin
前端: React, Next.js, React Native, Flutter
后端: Node.js, Express, GraphQL, REST APIs
数据库: PostgreSQL, Prisma, NeonDB, Supabase
DevOps: Docker, Kubernetes, Terraform, GitHub Actions, CircleCI
云服务: AWS, GCP, Azure
Development Workflow
开发工作流
1. Setup and Configuration
1. 环境搭建与配置
bash
undefinedbash
undefinedInstall dependencies
安装依赖
npm install
npm install
or
或
pip install -r requirements.txt
pip install -r requirements.txt
Configure environment
配置环境变量
cp .env.example .env
undefinedcp .env.example .env
undefined2. Run Quality Checks
2. 运行质量检查
bash
undefinedbash
undefinedUse the analyzer script
使用分析脚本
python scripts/code_quality_checker.py .
python scripts/code_quality_checker.py .
Review recommendations
查看优化建议
Apply fixes
应用修复
undefinedundefined3. Implement Best Practices
3. 遵循最佳实践
Follow the patterns and practices documented in:
references/code_review_checklist.mdreferences/coding_standards.mdreferences/common_antipatterns.md
遵循以下文档中记录的模式与实践:
references/code_review_checklist.mdreferences/coding_standards.mdreferences/common_antipatterns.md
Best Practices Summary
最佳实践总结
Code Quality
代码质量
- Follow established patterns
- Write comprehensive tests
- Document decisions
- Review regularly
- 遵循已确立的模式
- 编写全面的测试用例
- 记录决策过程
- 定期进行代码审查
Performance
性能
- Measure before optimizing
- Use appropriate caching
- Optimize critical paths
- Monitor in production
- 先测量再优化
- 使用合适的缓存策略
- 优化关键路径
- 在生产环境中监控
Security
安全
- Validate all inputs
- Use parameterized queries
- Implement proper authentication
- Keep dependencies updated
- 验证所有输入
- 使用参数化查询
- 实现适当的认证机制
- 保持依赖项更新
Maintainability
可维护性
- Write clear code
- Use consistent naming
- Add helpful comments
- Keep it simple
- 编写清晰的代码
- 使用一致的命名规范
- 添加有用的注释
- 保持简洁
Common Commands
常用命令
bash
undefinedbash
undefinedDevelopment
开发
npm run dev
npm run build
npm run test
npm run lint
npm run dev
npm run build
npm run test
npm run lint
Analysis
分析
python scripts/code_quality_checker.py .
python scripts/review_report_generator.py --analyze
python scripts/code_quality_checker.py .
python scripts/review_report_generator.py --analyze
Deployment
部署
docker build -t app:latest .
docker-compose up -d
kubectl apply -f k8s/
undefineddocker build -t app:latest .
docker-compose up -d
kubectl apply -f k8s/
undefinedTroubleshooting
故障排除
Common Issues
常见问题
Check the comprehensive troubleshooting section in .
references/common_antipatterns.md请查看中的全面故障排除章节。
references/common_antipatterns.mdGetting Help
获取帮助
- Review reference documentation
- Check script output messages
- Consult tech stack documentation
- Review error logs
- 查阅参考文档
- 检查脚本输出信息
- 参考技术栈文档
- 查看错误日志
Resources
资源
- Pattern Reference:
references/code_review_checklist.md - Workflow Guide:
references/coding_standards.md - Technical Guide:
references/common_antipatterns.md - Tool Scripts: directory
scripts/
- 模式参考:
references/code_review_checklist.md - 工作流指南:
references/coding_standards.md - 技术指南:
references/common_antipatterns.md - 工具脚本:目录
scripts/