Codex 协作框架 - 让 Claude Code 和 Codex CLI 高效协作 功能特性: - 智能任务分类(简单/中等/复杂) - 标准化协作流程 - 4个专业模板(代码审查、需求分析、方案设计、调试分析) - 会话管理最佳实践 - 安全规范内置 Co-Authored-By: Claude <noreply@anthropic.com>
97 lines
2.2 KiB
Markdown
97 lines
2.2 KiB
Markdown
# Code Review Template
|
||
|
||
## Template Variables
|
||
- `{modified_files}`: List of modified files
|
||
- `{change_description}`: Description of changes made
|
||
- `{requirement}`: Original requirement/user story
|
||
|
||
## Prompt Template
|
||
|
||
```
|
||
请作为资深代码审查专家,审查以下代码改动:
|
||
|
||
## 改动文件列表
|
||
{modified_files}
|
||
|
||
## 改动说明
|
||
{change_description}
|
||
|
||
## 原始需求
|
||
{requirement}
|
||
|
||
## 审查检查清单
|
||
|
||
请按以下维度进行审查:
|
||
|
||
### 1. 正确性 (Correctness)
|
||
- [ ] 代码逻辑是否正确实现了需求
|
||
- [ ] 是否有明显的bug或逻辑错误
|
||
- [ ] 边界条件和异常情况是否处理
|
||
- [ ] 数据验证是否充分
|
||
|
||
### 2. 代码质量 (Code Quality)
|
||
- [ ] 代码可读性和可维护性
|
||
- [ ] 命名是否清晰准确
|
||
- [ ] 是否有重复代码
|
||
- [ ] 函数和类的职责是否单一
|
||
|
||
### 3. 性能 (Performance)
|
||
- [ ] 是否有明显的性能问题
|
||
- [ ] 资源使用是否合理
|
||
- [ ] 是否有不必要的计算或IO操作
|
||
- [ ] 算法复杂度是否合理
|
||
|
||
### 4. 安全性 (Security)
|
||
- [ ] 是否有安全漏洞
|
||
- [ ] 输入验证是否充分
|
||
- [ ] 敏感信息是否正确处理
|
||
- [ ] 权限检查是否完善
|
||
|
||
### 5. 测试覆盖 (Testing)
|
||
- [ ] 关键逻辑是否有测试覆盖
|
||
- [ ] 测试用例是否充分
|
||
- [ ] 边界条件是否测试
|
||
|
||
### 6. 文档 (Documentation)
|
||
- [ ] 复杂逻辑是否有注释
|
||
- [ ] API文档是否完整
|
||
- [ ] 变更日志是否更新
|
||
|
||
## 审查结论
|
||
|
||
请提供:
|
||
1. 总体评价(优秀/良好/需改进/不合格)
|
||
2. 主要优点(1-3点)
|
||
3. 必须修复的问题(如有)
|
||
4. 建议改进的地方(如有)
|
||
5. 其他意见
|
||
```
|
||
|
||
## Usage Example
|
||
|
||
```python
|
||
# After completing code changes
|
||
modified_files = """
|
||
- src/auth/login.py: 添加用户登录验证
|
||
- src/auth/jwt.py: 实现JWT token生成和验证
|
||
- tests/test_login.py: 添加登录测试用例
|
||
"""
|
||
|
||
change_description = """
|
||
实现了基于JWT的用户认证系统:
|
||
1. 用户登录验证(用户名+密码)
|
||
2. JWT token生成和验证
|
||
3. token过期处理
|
||
4. 单元测试覆盖
|
||
"""
|
||
|
||
requirement = "实现用户登录功能,支持JWT token认证"
|
||
|
||
# Call Codex for review
|
||
codex(
|
||
PROMPT=f"<review template with variables>",
|
||
cd="/project",
|
||
SESSION_ID=previous_session
|
||
)
|
||
```
|