Skip to content

Commit 427fbbf

Browse files
committed
Merge branch '3.6.x'
2 parents 90e6d93 + 530cf1b commit 427fbbf

22 files changed

+4372
-88
lines changed

.claude/commands/commit.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
---
2+
name: "commit"
3+
description: "提交当前变更到 Git"
4+
usage: "/commit"
5+
---
6+
7+
# Commit Command
8+
19
提交当前变更到 Git。
210

311
**此命令已迁移到官方插件,将调用 `commit-commands` 插件。**

.claude/commands/fix-permissions.md

Lines changed: 0 additions & 88 deletions
This file was deleted.

.claude/commands/test.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
name: "test"
3+
description: "执行完整的测试流程"
4+
usage: "/test"
5+
---
6+
7+
# Test Command
8+
9+
## 功能说明
10+
111
执行完整的测试流程,包括单元测试、构建验证和集成测试。
212

313
**用法:**

.codex/README.md

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# Codex 项目级 Prompts
2+
3+
本目录提供仓库内的 Codex prompts(用于生成/管理 slash 命令的文档版本)。
4+
由于 Codex CLI 的自定义 prompts 只会从用户目录读取(默认 `~/.codex/prompts/`),
5+
这里的内容需要手动安装到本地目录后才会生效。
6+
7+
## 安装到本地
8+
9+
运行安装脚本,将本目录的 prompts 复制到 `~/.codex/prompts/`
10+
11+
```bash
12+
bash .codex/scripts/install-prompts.sh
13+
```
14+
15+
安装完成后,使用 `/prompts:<name>` 调用(例如:`/prompts:analyze-issue`)。
16+
17+
## 使用提示
18+
19+
- 这些 prompts 以"仓库根目录"为默认上下文。
20+
- 作为全局 prompts 使用时,请先切换到目标仓库或显式指定路径(详见各命令文件中的"使用前:选择目标仓库")。
21+
22+
## Prompt 文件格式规范
23+
24+
本目录下的 prompts 采用混合格式,既符合 Codex 官方规范,又保留完整的使用示例:
25+
26+
### 混合格式(兼容官方标准)
27+
28+
```yaml
29+
---
30+
description: 命令的功能描述
31+
usage: /prompts:command-name <参数>
32+
argument-hint: <参数>
33+
---
34+
```
35+
36+
### 字段说明
37+
38+
- **description** (必需): 描述 prompt 的功能,使用中文
39+
- **usage** (推荐): 完整的使用示例,包含命令名和参数
40+
- 格式:`/prompts:command-name <参数>`
41+
- 提供完整的调用示例供参考
42+
- **argument-hint** (可选): 仅参数部分的描述(Codex 官方格式)
43+
- 使用 `<param>` 表示必需参数
44+
- 使用 `[param]` 表示可选参数
45+
- 使用 `[--flag=<value>]` 表示可选标志参数
46+
- 仅包含参数部分,不含命令名称
47+
48+
### 调用方式
49+
50+
- 在 Codex CLI 中使用 `/prompts:filename` 调用(不含 .md 扩展名)
51+
- 例如:`/prompts:analyze-issue <issue-number>`
52+
53+
### 示例
54+
55+
**有参数的命令**
56+
```yaml
57+
---
58+
description: 分析 GitHub Issue 并创建需求分析文档
59+
usage: /prompts:analyze-issue <issue-number>
60+
argument-hint: <issue-number>
61+
---
62+
```
63+
64+
**有多个参数的命令**
65+
```yaml
66+
---
67+
description: 升级项目依赖
68+
usage: /prompts:upgrade-dependency <package-name> <from-version> <to-version>
69+
argument-hint: <package-name> <from-version> <to-version>
70+
---
71+
```
72+
73+
**无参数的命令**
74+
```yaml
75+
---
76+
description: 执行完整的测试流程
77+
usage: /prompts:test
78+
---
79+
```
80+
81+
### 格式说明
82+
83+
- ✅ 兼容 Codex 官方格式(使用 `argument-hint`
84+
- ✅ 保留完整使用示例(使用 `usage`
85+
- ✅ 文件名即为 prompt 名称,无需 `name` 字段
86+
- ✅ 所有字段值不使用引号
87+
88+
## 可用命令列表
89+
90+
所有命令都支持 Codex CLI(通过 `/prompts:command-name` 调用):
91+
92+
**任务管理**
93+
- `analyze-issue` - 分析 GitHub Issue 并创建需求分析文档
94+
- `plan-task` - 设计技术方案并输出实施计划
95+
- `implement-task` - 根据技术方案实施任务
96+
- `review-task` - 审查任务实现并输出代码审查报告
97+
- `refinement-task` - 处理代码审查反馈并修复问题
98+
- `complete-task` - 标记任务完成并归档到 completed 目录
99+
- `task-status` - 查看任务的当前状态和进度
100+
- `block-task` - 标记任务阻塞并记录阻塞原因
101+
102+
**Git 操作**
103+
- `commit` - 提交当前变更到 Git(提供最佳实践指南)
104+
- `create-pr` - 创建 Pull Request
105+
- `sync-pr` - 将任务处理进度同步到 PR 评论
106+
- `sync-issue` - 将任务处理进度同步到 Issue 评论
107+
- `refine-title` - 重构 Issue/PR 标题为 Conventional Commits 格式
108+
109+
**依赖和安全**
110+
- `upgrade-dependency` - 升级项目依赖
111+
- `analyze-security` - 分析 Dependabot 安全告警并创建修复任务
112+
- `close-security` - 关闭 Dependabot 安全告警(需提供合理理由)
113+
114+
**其他**
115+
- `test` - 执行完整的测试流程
116+
117+
## 常见问题
118+
119+
### Q: 为什么我无法使用 `/commit-commands:commit`
120+
121+
A: 这是 Claude Code 的官方插件命令,在 Codex CLI 中不可用。请使用 `/prompts:commit` 查看提交指南,然后手动执行 Git 命令。
122+
123+
### Q: 如何进行代码审查?
124+
125+
A: 使用 `/prompts:review-task <task-id>` 查看详细的审查清单,然后按照清单手动审查代码。Claude Code 用户可以使用 `/code-review:code-review` 进行自动审查。
126+
127+
### Q: 命令文件中提到的插件功能我能用吗?
128+
129+
A: 如果命令文件中标记为"Claude Code 插件"或"Codex CLI 不支持",则这些功能仅适用于 Claude Code。请使用文档中提供的替代方法(通常是手动操作步骤)。

0 commit comments

Comments
 (0)