@routerhub/agent-rules 1.5.57 → 1.5.59
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 +9 -0
- package/package.json +1 -1
- package/rules/devops.md +7 -0
- package/rules/global.md +2 -0
package/AGENTS.base.md
CHANGED
|
@@ -22,6 +22,8 @@
|
|
|
22
22
|
|
|
23
23
|
## PR 提交、评审与合入规范
|
|
24
24
|
|
|
25
|
+
- ⚠️ **强制要求:所有 PR 的 Title、Description、Test Plan 等全部文字内容必须使用中文编写**,方便团队成员阅读理解,禁止使用英文撰写 PR 内容。
|
|
26
|
+
- ⚠️ **强制要求:所有 PR 必须附上相关截图作为可视化证据**,无论是否涉及 UI 改动。截图需包含:功能效果截图、测试结果截图、关键代码变更对比截图等,让 reviewer 无需拉取代码即可直观理解改动内容与验证结果。
|
|
25
27
|
- PR 的目标是让审阅者在不依赖私下沟通的情况下独立理解、验证并放心 Approve;一个好的 PR 必须自解释。
|
|
26
28
|
- 一个 PR 只做一件事(One logical change per PR),必须是完整、独立、可审阅的逻辑改动,禁止把重构、修 bug、加功能混在同一个 PR。
|
|
27
29
|
- PR 应保持小而聚焦,尽量控制在约 200 行以内,超过 500 行应优先拆分;小 PR 审得快、回滚风险低、`git bisect` 定位更精准。
|
|
@@ -316,3 +318,10 @@ function FieldTooltip({ text }: { text: string }) {
|
|
|
316
318
|
2. **合并当前分支到 test**:将当前功能分支合并到 `test` 分支。
|
|
317
319
|
3. **部署 test 分支**:按当前项目自己的部署方式部署 `test` 分支(如 Cloud Run 部署、容器部署、npm publish 等)。
|
|
318
320
|
4. **发新版本**:按当前项目自己的发版规则发布新版本(如 `./release.sh`、自动递增版本号等)。
|
|
321
|
+
- ⚠️ **部署必须自包含,禁止部署后人工补操作**:后端代码写完并部署时,所有依赖该代码的准备工作必须一并完成并通过自动化方式执行,不允许部署完成后再由人工手动执行命令补救。常见必须自动化的事项包括:
|
|
322
|
+
- **数据库 migration**:涉及 schema 变更(新增表、字段、索引、约束等)时,必须同时编写 migration 脚本,并集成到部署流程中自动执行(如应用启动时自动 migrate、CI/CD 中跑 migrate 命令等),禁止部署后人工登数据库手动执行 DDL。
|
|
323
|
+
- **数据迁移/回填脚本**:涉及存量数据清洗、转换、回填时,脚本必须随代码一起提交,并在部署流程中自动执行或在 PR 中明确写出执行计划。
|
|
324
|
+
- **配置变更**:涉及 Nacos 配置中心新增/修改配置项时,配置变更必须与代码部署同步完成,并在部署流程中自动同步或通过配置管理工具批量推送。
|
|
325
|
+
- **依赖更新**:涉及新的系统依赖(如新的中间件、新的外部服务地址、新的环境变量等)时,必须在部署脚本中自动检查依赖可用性,不存在时部署失败并明确报错,禁止静默跳过等人工发现。
|
|
326
|
+
- **缓存/队列/索引重建**:涉及 Redis 缓存结构变更、消息队列 topic 新增、ES 索引 mapping 变更等,必须脚本化并自动执行。
|
|
327
|
+
- 以上所有自动化脚本必须在 PR 的 Test Plan 中明确写出执行时机(部署前/部署中/部署后)、执行方式和验证方法,不得只写"部署后手动执行"。
|
package/package.json
CHANGED
package/rules/devops.md
CHANGED
|
@@ -14,3 +14,10 @@ outputName: "devops"
|
|
|
14
14
|
2. **合并当前分支到 test**:将当前功能分支合并到 `test` 分支。
|
|
15
15
|
3. **部署 test 分支**:按当前项目自己的部署方式部署 `test` 分支(如 Cloud Run 部署、容器部署、npm publish 等)。
|
|
16
16
|
4. **发新版本**:按当前项目自己的发版规则发布新版本(如 `./release.sh`、自动递增版本号等)。
|
|
17
|
+
- ⚠️ **部署必须自包含,禁止部署后人工补操作**:后端代码写完并部署时,所有依赖该代码的准备工作必须一并完成并通过自动化方式执行,不允许部署完成后再由人工手动执行命令补救。常见必须自动化的事项包括:
|
|
18
|
+
- **数据库 migration**:涉及 schema 变更(新增表、字段、索引、约束等)时,必须同时编写 migration 脚本,并集成到部署流程中自动执行(如应用启动时自动 migrate、CI/CD 中跑 migrate 命令等),禁止部署后人工登数据库手动执行 DDL。
|
|
19
|
+
- **数据迁移/回填脚本**:涉及存量数据清洗、转换、回填时,脚本必须随代码一起提交,并在部署流程中自动执行或在 PR 中明确写出执行计划。
|
|
20
|
+
- **配置变更**:涉及 Nacos 配置中心新增/修改配置项时,配置变更必须与代码部署同步完成,并在部署流程中自动同步或通过配置管理工具批量推送。
|
|
21
|
+
- **依赖更新**:涉及新的系统依赖(如新的中间件、新的外部服务地址、新的环境变量等)时,必须在部署脚本中自动检查依赖可用性,不存在时部署失败并明确报错,禁止静默跳过等人工发现。
|
|
22
|
+
- **缓存/队列/索引重建**:涉及 Redis 缓存结构变更、消息队列 topic 新增、ES 索引 mapping 变更等,必须脚本化并自动执行。
|
|
23
|
+
- 以上所有自动化脚本必须在 PR 的 Test Plan 中明确写出执行时机(部署前/部署中/部署后)、执行方式和验证方法,不得只写"部署后手动执行"。
|
package/rules/global.md
CHANGED
|
@@ -22,6 +22,8 @@ name: "通用规则"
|
|
|
22
22
|
|
|
23
23
|
## PR 提交、评审与合入规范
|
|
24
24
|
|
|
25
|
+
- ⚠️ **强制要求:所有 PR 的 Title、Description、Test Plan 等全部文字内容必须使用中文编写**,方便团队成员阅读理解,禁止使用英文撰写 PR 内容。
|
|
26
|
+
- ⚠️ **强制要求:所有 PR 必须附上相关截图作为可视化证据**,无论是否涉及 UI 改动。截图需包含:功能效果截图、测试结果截图、关键代码变更对比截图等,让 reviewer 无需拉取代码即可直观理解改动内容与验证结果。
|
|
25
27
|
- PR 的目标是让审阅者在不依赖私下沟通的情况下独立理解、验证并放心 Approve;一个好的 PR 必须自解释。
|
|
26
28
|
- 一个 PR 只做一件事(One logical change per PR),必须是完整、独立、可审阅的逻辑改动,禁止把重构、修 bug、加功能混在同一个 PR。
|
|
27
29
|
- PR 应保持小而聚焦,尽量控制在约 200 行以内,超过 500 行应优先拆分;小 PR 审得快、回滚风险低、`git bisect` 定位更精准。
|