@routerhub/agent-rules 1.5.13 → 1.5.16

package/AGENTS.base.md

@@ -23,6 +23,7 @@
 - PR Title 示例：`[auth] Fix token refresh race condition on concurrent requests`、`[payments] Add idempotency key to charge API`、`[infra] Migrate cache layer from Redis 6 to Redis 7`。
 - PR Title 禁止使用 `fix bug`、`update code`、`改了一下` 等无法表达实际改动的标题。
 - PR Description 必须足够充分，至少回答 What（改了什么）、Why（为什么改，解决什么问题或满足什么需求）、How（采用什么方案，为什么选该方案）。
+- PR Description 和 Test Plan 的文字应尽可能简洁明了，优先用页面操作路径、按钮点击、表单输入、可见结果描述验证过程；尽量少用代码片段解释，除非代码是理解变更或复现问题的必要证据。
 - 涉及行为变更、接口变更、数据迁移、性能影响时，必须在 Description 中显式写出。
 - 有意不做的事、已知局限、后续 follow-up 必须写清楚，避免 reviewer 重复追问。
 - 关联 issue 必须在 PR 中链接，并优先使用 GitHub 关键字自动关闭，例如 `Closes #123`、`Fixes #123`。
@@ -101,6 +102,8 @@ Closes #456
 
 - 所有新建文档必须使用 HTML 格式（`.html`），禁止使用 Markdown（`.md`）格式。
 - 已有的 `.md` 文件可保留，但新增文档一律使用 HTML。
+- 编写 HTML 文档时，文档标题、正文、章节、说明文字、图注、表格等内容必须使用中文；仅代码、命令、专有名词、接口字段或页面 UI 原文可保留英文。
+- 编写 HTML 文档时，所有图片资源（包括截图、图表、插图等）必须以 base64 data URI 形式内嵌到 HTML 中，禁止引用或额外输出独立的 PNG、JPG、JPEG、SVG、WebP 等图片文件，确保他人只打开 HTML 文件即可看到全部内容并用于发版。
 
 ## 优先级
 

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 所有对 @routerhub/agent-rules 的重大更改都会记录在这个文件中。
 
+## [1.5.16] - 2026-06-08
+
+### Added
+
+- 新增 HTML 文档中文内容规则，要求 HTML 文档标题、正文、章节、说明文字、图注和表格等内容默认使用中文。
+
+## [1.5.15] - 2026-06-05
+
+### Added
+
+- 新增 PR 描述与测试计划表达规则，要求文字尽量简洁明了，并优先通过页面操作路径和可见结果说明验证过程，减少非必要代码片段解释。
+
+## [1.5.14] - 2026-06-05
+
+### Changed
+
+- 强化 HTML 文档图片规则，要求所有图片资源以 base64 data URI 内嵌，确保单个 HTML 文件即可完整查看并用于发版。
+
 ## [1.5.13] - 2026-06-03
 
 ### Added

package/README.md

@@ -1,37 +1,21 @@
 # @routerhub/agent-rules
 
-只做两件事：
-
-1. 生成项目可用的 `AGENTS.md` 和 `.github/copilot-instructions.md`
-2. 自动监听 `AGENTS.private.md` 并同步
-
-完整中文说明见 `README.zh-CN.md`。
+帮你自动生成给AI看的提示文件，这样每次AI都会参考你的规则
 
 ## 安装
 
-在你的项目里安装：
+在你的项目里安装即可：
 
 ```bash
-pnpm add -D @routerhub/agent-rules
+pnpm i -D @routerhub/agent-rules
 ```
 
-安装完成后会自动：
-
-1. 生成 `AGENTS.md` 和 `.github/copilot-instructions.md`
-2. 在后台启动 watch 进程，持续监听 `AGENTS.private.md` 变更并自动同步
-
-无需手动执行任何命令，修改 `AGENTS.private.md` 即可自动生效。
-
-> **注意：** 后台 watch 进程在重启电脑后会停止。如需每次启动开发时自动恢复监听，可在 `package.json` 中配合 `concurrently` 使用：
->
-> ```bash
-> pnpm add -D concurrently
-> ```
->
-> ```json
-> {
->   "scripts": {
->     "dev": "concurrently \"next dev\" \"agent-rules watch\""
->   }
-> }
-> ```
+## 使用
+
+安装完成后，只在当前项目的 `AGENTS.private.md` 中编写项目私有规则。
+
+如果需要修改公共规则，请在 `agent-rules` 项目中维护，不要写到业务项目的 `AGENTS.private.md` 里。
+
+写完 `AGENTS.private.md` 后，工具会自动生成项目可用的 `AGENTS.md` 和 `.github/copilot-instructions.md`。
+
+注意：pnpm i 的时候会启动一个watch函数自动帮你合并AGENTS.privite.md中的内容到AGENTNS.md，所以建议给项目配置一键启动脚本来，一键启动脚本里加上先pnpm i然后再启动每个项目

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routerhub/agent-rules",
-  "version": "1.5.13",
+  "version": "1.5.16",
   "description": "Shared Copilot agent rules and guidelines for RouterHub projects",
   "main": "AGENTS.base.md",
   "bin": {