Skip to content

Commit 9d405de

Browse files
CodeCasterXclaude
andcommitted
docs: 将自定义命令迁移为插件引用文档
将 commit 和 review 命令改造为官方插件的引导文档: - commit.md 引导使用 commit-commands 插件 - review.md 引导使用 code-review 和 pr-review-toolkit 插件 - 保留简短命令名,同时获得插件的强大功能 - 添加详细的插件使用说明和功能对比 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
1 parent faab38b commit 9d405de

File tree

2 files changed

+70
-85
lines changed

2 files changed

+70
-85
lines changed

.claude/commands/commit.md

Lines changed: 21 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,27 @@
11
提交当前变更到 Git。
22

3-
**用法:**
4-
- `/commit` - 交互式提交(会询问提交信息)
5-
- `/commit <message>` - 直接提交并使用指定消息
6-
7-
**执行步骤:**
8-
9-
1. **查看当前变更**
10-
```
11-
git status
12-
git diff --stat
13-
```
14-
15-
2. **如果有未追踪的文件,询问用户是否添加**
16-
- 列出所有 untracked 文件
17-
- 排除 `.claude/` 目录
18-
- 让用户确认要添加哪些文件
19-
20-
3. **添加文件到暂存区**
21-
```
22-
git add <files>
23-
```
3+
**此命令已迁移到官方插件,将调用 `commit-commands` 插件。**
244

25-
4. **创建提交**
26-
- 如果用户提供了消息,使用该消息
27-
- 如果没有消息,根据变更内容生成合适的提交消息
28-
- 提交消息格式遵循项目规范
29-
- 添加 Co-Authored-By 签名
30-
31-
```
32-
git commit -m "$(cat <<'EOF'
33-
<提交消息>
34-
35-
🤖 Generated with [Claude Code](https://claude.com/claude-code)
36-
37-
Co-Authored-By: Claude <[email protected]>
38-
EOF
39-
)"
40-
```
41-
42-
5. **显示提交结果**
43-
```
44-
git log -1 --stat
45-
git status
46-
```
5+
**用法:**
6+
- `/commit` - 创建 Git 提交
7+
- `/commit-commands:commit` - 直接使用插件命令
8+
- `/commit-commands:commit-push-pr` - 一键提交+推送+创建PR
9+
10+
**实际执行:**
11+
调用 `/commit-commands:commit` 插件命令
12+
13+
**插件功能:**
14+
- 自动分析变更内容
15+
- 生成符合规范的提交消息
16+
- 支持交互式和直接提交模式
17+
- 添加 Co-Authored-By 签名
18+
- 自动检测敏感信息
19+
20+
**扩展用法:**
21+
如需一键完成提交→推送→创建PR,使用:
22+
```
23+
/commit-commands:commit-push-pr
24+
```
4725

4826
**注意事项:**
4927
- 不要提交包含敏感信息的文件(.env, credentials 等)

.claude/commands/review.md

Lines changed: 49 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,52 @@
11
审查指定的 Pull Request。
22

3+
**此命令已迁移到官方插件,提供更专业的多维度审查。**
4+
35
**用法:**
4-
- `/review <pr-number>` - 审查指定的PR
5-
- 例如:`/review 369`
6-
7-
**执行步骤:**
8-
9-
1. **获取PR信息**
10-
```
11-
gh pr view <pr-number>
12-
gh pr diff <pr-number>
13-
gh pr checks <pr-number>
14-
```
15-
16-
2. **分析PR内容**
17-
- 检查PR标题是否符合规范
18-
- 检查PR描述是否完整填写了模板
19-
- 审查代码变更的合理性
20-
- 检查是否有潜在的安全问题
21-
- 验证测试覆盖情况
22-
23-
3. **检查模板合规性**
24-
- 对照 `.github/pull_request_template.md` 检查必填项
25-
- 确认所有检查项都已勾选
26-
- 验证变更类型选择是否正确
27-
28-
4. **生成审查报告**
29-
- 列出发现的问题
30-
- 给出改进建议
31-
- 标注需要特别关注的地方
32-
33-
5. **可选:添加审查评论**
34-
- 如果用户同意,可以使用 `gh pr comment` 添加评论
35-
- 提供建设性的反馈
36-
37-
**审查要点:**
38-
- ✅ PR 标题格式正确
39-
- ✅ 描述完整填写了模板
40-
- ✅ 变更类型选择正确
41-
- ✅ 测试覆盖充分
42-
- ✅ 代码质量良好
43-
- ✅ 没有安全隐患
44-
- ✅ 文档已更新
45-
- ✅ 向后兼容性考虑
6+
- `/review` - 基础审查(调用插件)
7+
- `/code-review:code-review <pr-number>` - 深度代码审查(5个并行代理)
8+
- `/pr-review-toolkit:review-pr` - 专业PR审查(6个专业代理)
9+
10+
**推荐使用插件命令:**
11+
12+
### 方案1:深度代码审查(推荐)
13+
```
14+
/code-review:code-review <pr-number>
15+
```
16+
**功能:**
17+
- 5个并行 Sonnet 代理审查
18+
- CLAUDE.md 规范合规性检查
19+
- Bug 检测与历史上下文分析
20+
- 信心分数过滤误判
21+
- 适合:需要全面深度审查时
22+
23+
### 方案2:专业PR审查工具包
24+
```
25+
/pr-review-toolkit:review-pr
26+
```
27+
**功能:**
28+
- 6个专业审查代理,包括:
29+
- 代码注释准确性分析
30+
- 测试覆盖质量审查
31+
- 错误处理检查(静默失败检测)
32+
- 类型设计质量分析
33+
- 通用代码质量审查
34+
- 代码简化优化建议
35+
- 适合:需要多角度专业建议时
36+
37+
**审查维度对比:**
38+
39+
| 审查内容 | code-review | pr-review-toolkit |
40+
|---------|-------------|-------------------|
41+
| CLAUDE.md 合规 |||
42+
| Bug 检测 |||
43+
| 测试覆盖 | ⚠️ | ✅ 专业代理 |
44+
| 错误处理 | ⚠️ | ✅ 静默失败检测 |
45+
| 注释质量 | ⚠️ | ✅ 专业代理 |
46+
| 类型设计 | ⚠️ | ✅ 专业代理 |
47+
| 代码简化 | ⚠️ | ✅ 专业代理 |
48+
49+
**使用建议:**
50+
- 日常PR审查:使用 `/code-review:code-review`
51+
- 重要功能/复杂PR:使用 `/pr-review-toolkit:review-pr`
52+
- 快速检查:直接询问 Claude 具体问题

0 commit comments

Comments
 (0)