@routerhub/agent-rules 1.5.133 → 1.5.135
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/AGENTS.base.md
CHANGED
|
@@ -114,6 +114,7 @@
|
|
|
114
114
|
- ⚠️ **截图必须直接内嵌在 PR Description 中,让 reviewer 打开 PR 就能看到效果图(`` 方式渲染为可见图片),禁止只在文字里描述"改动了什么"而不放图,也禁止把截图只作为文件附件/提交到分支目录而不在 PR 正文中引用。** 原因:reviewer 看 PR 的第一眼就是看描述,如果看不到图、只能读文字,完全无法直观感知改动效果;截图不内嵌 = 等于没附。
|
|
115
115
|
- ⚠️ **截图必须通过 PR Description 编辑区直接上传(拖拽/粘贴/文件选择按钮),禁止走评论区 `input[type=file]` 上传后再搬运 CDN URL。** 原因:PR Description 编辑区本身支持图片拖拽上传、自动转为 `` 内嵌,一步到位;走评论区上传需要多一步「提交评论 → 复制 URL → 粘贴到 Description」,产生的临时图片评论会留在 PR 对话里干扰 reviewer 阅读,且多了一步手动搬运、容易出错。
|
|
116
116
|
- ⚠️ 创建 PR 使用 `/create-pr` skill(自动生成中文内容 + 效果截图 + CDN 上传)。
|
|
117
|
+
- ⚠️ **PR 创建即进入可评审状态**:直接创建正式 PR(非 Draft),创建完成、冲突检查与静态编译通过后即可直接交付 review,禁止先开 Draft PR、后续再手动标记 Ready for review。
|
|
117
118
|
- ⚠️ **每次修改 PR 后(含创建 PR、push 新提交、响应 review 意见重新推送等所有改动 PR 的动作之后),都必须检查与主分支(默认分支)是否有冲突**:用 `gh pr view <PR> --json mergeable -q .mergeable` 检查(`MERGEABLE`=无冲突可合并,`CONFLICTING`=存在冲突,`UNKNOWN`=GitHub 尚未判定,稍后复查)。若存在冲突,必须先解决冲突再交付 review——`git merge origin/main`(或 `git rebase origin/main`)→ 解决冲突文件 → 测试通过 → 推送,确保 PR 处于可合并状态,禁止把带冲突的 PR 抛给 reviewer。主分支随时可能前进,一个创建时无冲突的 PR 可能在后续 push 后悄悄变冲突,因此每次改动 PR 后都必须重新检查,禁止只在创建时查一次就以为高枕无忧。
|
|
118
119
|
- ⚠️ **每次修改 PR 后,除冲突检查外还必须检查 GitHub 静态编译是否通过,通过后发新版本**,三步收尾缺一不可:
|
|
119
120
|
1. **与主分支冲突检查**:按上一条规则执行(`gh pr view <PR> --json mergeable -q .mergeable`),有冲突必须先解决。
|
|
@@ -178,7 +179,8 @@
|
|
|
178
179
|
### HTML 文档截图与 curl 命令规范
|
|
179
180
|
|
|
180
181
|
- ⚠️ **HTML 文档中的截图必须以 `data:image/png;base64,...` 内嵌,禁止用文件路径或相对链接引用外部 PNG 文件。** 文档会被打开、移动、分享,外部图片路径一旦脱离原目录就全部失效,文档里全是裂图。生成文档后,散落的零散 PNG 文件应一并清理,只保留 HTML 本身。
|
|
181
|
-
- ⚠️ **curl 命令必须完整可复制执行,禁止省略关键参数。** 包括但不限于:API Key / Token
|
|
182
|
+
- ⚠️ **curl 命令必须完整可复制执行,禁止省略关键参数。** 包括但不限于:API Key / Token、请求体中的图片数据、完整的 URL。禁止用 `...` 或「省略其余参数」代替——看的人无法区分「这里不重要所以省略了」还是「这里我不会写所以跳过了」,前者让命令不可执行,后者掩盖了潜在的错误。
|
|
183
|
+
- ⚠️ **示例命令/文档(含截图版 HTML)中的 Token、密钥、环境变量等敏感值,直接内嵌真实值,禁止抽离成占位符(如 `${API_KEY}`)或省略号代替。** 原因:占位符和省略号让复制者无法直接运行、看不到真实效果,违背「可复制即用」的目的;本项目为私有仓库,外部不可见,内嵌真实值安全可控。仅当仓库将来转为公开时,才需将这类真实值替换回占位符。
|
|
182
184
|
- ⚠️ **测试用的图片等静态资源统一放到 `docs/images/` 目录,curl 命令中用相对路径引用**(如 `@docs/images/test.jpg`),确保命令在项目根目录下可直接执行。
|
|
183
185
|
- ⚠️ **一键执行脚本/命令必须能直接复制到终端执行,且文档中必须配「一键复制」按钮。** 每条命令必须完整可执行(禁止省略参数、禁止用 `...` 占位、禁止只给片段),在项目根目录下可直接运行;文档中命令块右上角必须提供复制按钮,点击即可将完整命令复制到剪贴板并给出「已复制」反馈。
|
|
184
186
|
- ⚠️ **文档中给出的每条命令/脚本,写入前必须亲自在终端实际执行验证过,确认确实可行后才能写入。** 执行失败的命令一律不得写入文档,禁止凭推断「应该能跑」就写进文档——推断得出的结论不能作为生成依据,必须实际测试过才能下结论。
|
package/package.json
CHANGED
package/rules/global.md
CHANGED
|
@@ -114,6 +114,7 @@ name: "通用规则"
|
|
|
114
114
|
- ⚠️ **截图必须直接内嵌在 PR Description 中,让 reviewer 打开 PR 就能看到效果图(`` 方式渲染为可见图片),禁止只在文字里描述"改动了什么"而不放图,也禁止把截图只作为文件附件/提交到分支目录而不在 PR 正文中引用。** 原因:reviewer 看 PR 的第一眼就是看描述,如果看不到图、只能读文字,完全无法直观感知改动效果;截图不内嵌 = 等于没附。
|
|
115
115
|
- ⚠️ **截图必须通过 PR Description 编辑区直接上传(拖拽/粘贴/文件选择按钮),禁止走评论区 `input[type=file]` 上传后再搬运 CDN URL。** 原因:PR Description 编辑区本身支持图片拖拽上传、自动转为 `` 内嵌,一步到位;走评论区上传需要多一步「提交评论 → 复制 URL → 粘贴到 Description」,产生的临时图片评论会留在 PR 对话里干扰 reviewer 阅读,且多了一步手动搬运、容易出错。
|
|
116
116
|
- ⚠️ 创建 PR 使用 `/create-pr` skill(自动生成中文内容 + 效果截图 + CDN 上传)。
|
|
117
|
+
- ⚠️ **PR 创建即进入可评审状态**:直接创建正式 PR(非 Draft),创建完成、冲突检查与静态编译通过后即可直接交付 review,禁止先开 Draft PR、后续再手动标记 Ready for review。
|
|
117
118
|
- ⚠️ **每次修改 PR 后(含创建 PR、push 新提交、响应 review 意见重新推送等所有改动 PR 的动作之后),都必须检查与主分支(默认分支)是否有冲突**:用 `gh pr view <PR> --json mergeable -q .mergeable` 检查(`MERGEABLE`=无冲突可合并,`CONFLICTING`=存在冲突,`UNKNOWN`=GitHub 尚未判定,稍后复查)。若存在冲突,必须先解决冲突再交付 review——`git merge origin/main`(或 `git rebase origin/main`)→ 解决冲突文件 → 测试通过 → 推送,确保 PR 处于可合并状态,禁止把带冲突的 PR 抛给 reviewer。主分支随时可能前进,一个创建时无冲突的 PR 可能在后续 push 后悄悄变冲突,因此每次改动 PR 后都必须重新检查,禁止只在创建时查一次就以为高枕无忧。
|
|
118
119
|
- ⚠️ **每次修改 PR 后,除冲突检查外还必须检查 GitHub 静态编译是否通过,通过后发新版本**,三步收尾缺一不可:
|
|
119
120
|
1. **与主分支冲突检查**:按上一条规则执行(`gh pr view <PR> --json mergeable -q .mergeable`),有冲突必须先解决。
|
|
@@ -178,7 +179,8 @@ name: "通用规则"
|
|
|
178
179
|
### HTML 文档截图与 curl 命令规范
|
|
179
180
|
|
|
180
181
|
- ⚠️ **HTML 文档中的截图必须以 `data:image/png;base64,...` 内嵌,禁止用文件路径或相对链接引用外部 PNG 文件。** 文档会被打开、移动、分享,外部图片路径一旦脱离原目录就全部失效,文档里全是裂图。生成文档后,散落的零散 PNG 文件应一并清理,只保留 HTML 本身。
|
|
181
|
-
- ⚠️ **curl 命令必须完整可复制执行,禁止省略关键参数。** 包括但不限于:API Key / Token
|
|
182
|
+
- ⚠️ **curl 命令必须完整可复制执行,禁止省略关键参数。** 包括但不限于:API Key / Token、请求体中的图片数据、完整的 URL。禁止用 `...` 或「省略其余参数」代替——看的人无法区分「这里不重要所以省略了」还是「这里我不会写所以跳过了」,前者让命令不可执行,后者掩盖了潜在的错误。
|
|
183
|
+
- ⚠️ **示例命令/文档(含截图版 HTML)中的 Token、密钥、环境变量等敏感值,直接内嵌真实值,禁止抽离成占位符(如 `${API_KEY}`)或省略号代替。** 原因:占位符和省略号让复制者无法直接运行、看不到真实效果,违背「可复制即用」的目的;本项目为私有仓库,外部不可见,内嵌真实值安全可控。仅当仓库将来转为公开时,才需将这类真实值替换回占位符。
|
|
182
184
|
- ⚠️ **测试用的图片等静态资源统一放到 `docs/images/` 目录,curl 命令中用相对路径引用**(如 `@docs/images/test.jpg`),确保命令在项目根目录下可直接执行。
|
|
183
185
|
- ⚠️ **一键执行脚本/命令必须能直接复制到终端执行,且文档中必须配「一键复制」按钮。** 每条命令必须完整可执行(禁止省略参数、禁止用 `...` 占位、禁止只给片段),在项目根目录下可直接运行;文档中命令块右上角必须提供复制按钮,点击即可将完整命令复制到剪贴板并给出「已复制」反馈。
|
|
184
186
|
- ⚠️ **文档中给出的每条命令/脚本,写入前必须亲自在终端实际执行验证过,确认确实可行后才能写入。** 执行失败的命令一律不得写入文档,禁止凭推断「应该能跑」就写进文档——推断得出的结论不能作为生成依据,必须实际测试过才能下结论。
|
|
@@ -124,5 +124,5 @@ gh pr checks <PR>
|
|
|
124
124
|
- ⚠️ 截图禁止提交到 Git 仓库
|
|
125
125
|
- ⚠️ PR 截图直接内嵌在 Description 正文中(Markdown 图片语法)
|
|
126
126
|
- ⚠️ 每次修改 PR 后(含创建、push 新提交、响应 review 意见)都必须做三步收尾:冲突检查 → 静态编译检查 → PR 合并后发新版本(见步骤 7)
|
|
127
|
-
-
|
|
127
|
+
- ⚠️ **直接创建正式 PR(非 Draft)**:PR 创建完成即进入可评审状态,可直接交付 review,禁止先开 Draft PR、后续再手动标记 Ready for review
|
|
128
128
|
- 作者不能 Approve 自己的 PR
|
|
@@ -166,7 +166,7 @@ gh pr comment $PR --body "Fixed in $COMMIT. Addresses outside-diff comment on fi
|
|
|
166
166
|
|
|
167
167
|
### 6. Run tests and push
|
|
168
168
|
|
|
169
|
-
Run the project test suite. All tests must pass before pushing. Push all fixes together to
|
|
169
|
+
Run the project test suite. All tests must pass before pushing. Push all fixes together to reduce intermediate-state noise; each push is still reviewed normally.
|
|
170
170
|
|
|
171
171
|
### 7. Submit review (optional)
|
|
172
172
|
|
|
@@ -197,13 +197,11 @@ gh pr edit $PR --milestone "[milestone-title]"
|
|
|
197
197
|
|
|
198
198
|
Do **not** assign automatically. This is a reminder only.
|
|
199
199
|
|
|
200
|
-
##
|
|
200
|
+
## Reviewing after every push
|
|
201
201
|
|
|
202
|
-
|
|
202
|
+
Bots (Gemini, Codex, etc.) review every push. **Each push should go through review** - never try to avoid or suppress reviews:
|
|
203
203
|
|
|
204
|
-
1. **Batch fixes**: accumulate all fixes, push once
|
|
205
|
-
2. **Draft PR**: convert to draft during fixes
|
|
206
|
-
3. **Commit keywords**: some bots respect `[skip ci]` or `[skip review]`
|
|
204
|
+
1. **Batch fixes**: accumulate all fixes, push once to reduce intermediate-state noise (each push is still reviewed normally)
|
|
207
205
|
|
|
208
206
|
## Important rules
|
|
209
207
|
|