Skip to content

Commit 43cbd56

Browse files
CodeCasterXCodeCasterX
committed
docs(opencode): 统一提交规范并调整命令配置
主要变更： 1. 统一提交信息规范： - AGENTS.md/GEMINI.md：从 [模块] 简述改为 Conventional Commits 格式 - .ai-agents/codex/README.md：更新提交规范说明 - .ai-agents/gemini/README.md：更新提交规范说明 - .claude/project-rules.md：格式从 type: 改为 type(scope): - .codex/commands/commit.md：补充 scope 说明并移除 Codex 签名 - .opencode/commands/commit.md：补充 scope 说明 2. 调整命令配置： - analyze-issue.md：agent 类型从 explore 改为 general - analyze-security.md：agent 类型从 explore 改为 general - 原因：explore 类型无法输出文件到指定目录 3. 文档同步： - AGENTS.en.md/GEMINI.en.md：同步英文版提交规范说明
1 parent a358a56 commit 43cbd56

11 files changed

Lines changed: 22 additions & 22 deletions

File tree

‎.ai-agents/codex/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,8 +169,8 @@ Codex 和 GeminiCli 可以互为替代或协作：
169169

170170
### 提交规范
171171

172-
- 提交信息：`[模块] 简述`
173-
- 例如：`[fit] 修复某问题`
172+
- 提交信息遵循 Conventional Commits：`<type>(<scope>): <subject>`
173+
- subject 使用中文且约 20 字以内，scope 为模块名（可省略）
174174
- 不要自动提交，等待人工确认
175175

176176
## Codex vs GeminiCli 选择建议

‎.ai-agents/gemini/README.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,6 @@ Gemini 应该：
9090

9191
### 提交规范
9292

93-
- 提交信息：`[模块] 简述`
94-
- 例如：`[fit] 修复某问题`
93+
- 提交信息遵循 Conventional Commits：`<type>(<scope>): <subject>`
94+
- subject 使用中文且约 20 字以内，scope 为模块名（可省略）
9595
- 不要自动提交，等待人工确认
96-

‎.claude/project-rules.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,11 +193,11 @@ Bash("OWNER_GROUP=$(ls -l README.md | awk '{print $3\":\"$4}') && sudo chown $OW
193193
194194
**⚠️ 重要规则（CRITICAL）：**
195195
196-
本项目的提交信息**必须使用中文作为核心内容**，遵循以下格式：
196+
本项目的提交信息**必须使用中文作为核心内容**，遵循 Conventional Commits 格式：
197197
198198
**标准格式：**
199199
```
200-
<type>: <中文描述>
200+
<type>(<scope>): <中文描述>
201201
202202
<可选的详细说明>
203203

‎.codex/commands/commit.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,9 @@ git log -3 --format="%s"
277277
```
278278

279279
**提交消息格式建议**：
280-
- 使用项目规范的格式（如 Conventional Commits）
280+
- 使用项目规范的格式（Conventional Commits）
281+
- 采用 `<type>(<scope>): <subject>`，subject 使用中文且约 20 字以内
282+
- scope 为模块名（可省略）
281283
- 第一行简明扼要（50字符以内）
282284
- 如需详细说明，空一行后添加正文
283285
- 说明改动的原因，而非改动的内容
@@ -291,8 +293,6 @@ git commit -m "$(cat <<'EOF'
291293
<type>(<scope>): <subject>
292294
293295
<body>
294-
295-
Co-Authored-By: Codex CLI <noreply@openai.com>
296296
EOF
297297
)"
298298
```

‎.opencode/commands/analyze-issue.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: 分析 GitHub Issue 并创建需求分析文档
3-
agent: explore
3+
agent: general
44
subtask: false
55
---
66

‎.opencode/commands/analyze-security.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: 分析 Dependabot 安全告警并创建安全分析文档
3-
agent: explore
3+
agent: general
44
subtask: false
55
---
66

‎.opencode/commands/commit.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ subtask: false
3434
2. 分析变更:
3535
- 确定变更类型(新功能/增强/Bug修复/重构/测试/文档等)
3636
- 生成符合规范的提交消息(参考最近的 commit 格式)
37-
- 提交消息格式: [模块] 简短描述(20字左右,中文)
37+
- 提交消息格式: `<type>(<scope>): <subject>`，subject 使用中文且约 20 字以内
38+
- scope 为模块名(如 fit、waterflow、fel)，可省略
3839
- 不要提交敏感文件(.env, credentials.json等)
3940

4041
**步骤 3: 提交代码**

‎AGENTS.en.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ This repo hosts the FIT framework and related engines.
3232

3333
## Commit & Pull Request Guidelines
3434

35-
- Commit messages use a module tag in brackets and a short Chinese summary, e.g. `[fit] 修复某问题`.
36-
- Keep commit subjects concise (around 20 characters); add details in the body if needed.
35+
- Commit messages follow Conventional Commits: `<type>(<scope>): <subject>`, with a Chinese subject around 20 characters.
36+
- Scope is the module name (e.g., `fit`, `waterflow`, `fel`) and can be omitted.
3737
- PRs should be based on the correct module/version branch and normally include a single commit.
3838

3939
## Security & Configuration Tips

‎AGENTS.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@
3232

3333
## 提交与 PR 规范
3434

35-
- 提交信息以模块标签开头，中文简述，例如 `[fit] 修复某问题`。
36-
- 标题建议 20 字左右，必要时在正文补充细节。
35+
- 提交信息遵循 Conventional Commits：`<type>(<scope>): <subject>`，subject 使用中文且约 20 字以内。
36+
- scope 为模块名（如 `fit`、`waterflow`、`fel`），可省略。
3737
- PR 基于正确的模块/版本分支，通常仅包含一次提交。
3838

3939
## 安全与配置提示

‎GEMINI.en.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ This repo hosts the FIT framework and related engines.
3232

3333
## Commit & Pull Request Guidelines
3434

35-
- Commit messages use a module tag in brackets and a short Chinese summary, e.g. `[fit] 修复某问题`.
36-
- Keep commit subjects concise (around 20 characters); add details in the body if needed.
35+
- Commit messages follow Conventional Commits: `<type>(<scope>): <subject>`, with a Chinese subject around 20 characters.
36+
- Scope is the module name (e.g., `fit`, `waterflow`, `fel`) and can be omitted.
3737
- PRs should be based on the correct module/version branch and normally include a single commit.
3838

3939
## Security & Configuration Tips

0 commit comments

Comments
 (0)