diff --git a/.gitmessage b/.gitmessage new file mode 100644 index 0000000..29c3abd --- /dev/null +++ b/.gitmessage @@ -0,0 +1,10 @@ +# [(scope)][!]: <中文描述，不超过 72 宽度，不加句号> +# 类型与 emoji：feat ✨ / fix 🐛 / docs 📝 / refactor ♻️ / perf ⚡️ / +# test ✅ / build 📦️ / ci 💚 / chore 🔧 / revert ⏪️ +# 例：✨ feat(client): 会话行悬停区加删除按钮 +# 例：🐛 fix(host): 延迟删除台账只记录根会话 +# +# ↓ 正文（可省略）：为什么这么改、影响面、迁移注意事项，每行不超过 72 宽度 +# +# +# ↓ 脚注（可省略）：Refs: #12 / Closes: #34 / BREAKING CHANGE: <中文说明> diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..74daf09 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,94 @@ +# 提交信息规范 + +本仓库的提交信息遵循 [Conventional Commits](https://www.conventionalcommits.org/) 的结构，并在行首加一个 emoji 做视觉标记。**描述用中文**，类型关键字、作用域、脚注关键字保持英文。 + +## 格式 + +```text + [(scope)][!]: <描述> +<空行> +[正文：为什么这么改、影响面、迁移注意事项] +<空行> +[脚注：Refs: #12 / Closes: #34 / BREAKING CHANGE: ...] +``` + +- ``：下面表格里该类型对应的 emoji，后面跟**一个空格**。 +- ``：小写英文关键字，见下表。 +- `(scope)`：可选，改动范围。用 `()` 包住一个简短英文标识，例如 `docs(ci)`、`fix(client)`、`feat(host)`。 +- `!`：可选，紧跟在 type 或 scope 之后、冒号之前，表示破坏性变更。 +- `<描述>`：中文，一句话，讲清这次改动做了什么。**首行不超过 72 个字符**（中文字符按 2 个宽度算），结尾不加句号。 +- 正文：中文，每行不超过 72 个宽度。说清"为什么"，不要复述 diff。单行描述足以讲明白时就省略。 +- 脚注：破坏性变更必须写 `BREAKING CHANGE: <中文说明>`，不能只靠 `!`。 + +## 类型与 emoji + +| 类型 | emoji | 码位 | 用途 | +| --- | --- | --- | --- | +| `feat` | ✨ | `U+2728` | 新增功能 | +| `fix` | 🐛 | `U+1F41B` | 修复缺陷 | +| `docs` | 📝 | `U+1F4DD` | 只改文档 | +| `refactor` | ♻️ | `U+267B U+FE0F` | 重构，行为不变 | +| `perf` | ⚡️ | `U+26A1 U+FE0F` | 性能优化 | +| `test` | ✅ | `U+2705` | 变更测试 | +| `build` | 📦️ | `U+1F4E6 U+FE0F` | 构建系统或依赖 | +| `ci` | 💚 | `U+1F49A` | CI 配置 | +| `chore` | 🔧 | `U+1F527` | 杂项，以上都不属于时用 | +| `revert` | ⏪️ | `U+23EA U+FE0F` | 回滚某次提交，正文写 `Refs: <被回滚的提交>` | + +**复制上表里的 emoji，不要手敲。** 带 `U+FE0F` 的那五个是「基础字符 + 变体选择符」两个码位，手敲时很容易只打出前一个字符；对工具来说 `♻`（`U+267B`）和 `♻️`（`U+267B U+FE0F`）是两个不同的字符串，比对会失败。写规范或写脚本时，比较 emoji 前先做一次 NFC 归一化，或把两边都按 `\uFE0F?` 处理。 + +## 示例 + +新增功能： + +```text +✨ feat(client): 会话行悬停区加删除按钮 + +官方 archive 与 pin 两个悬停按钮保持原位，本插件的删除按钮插在两者 +之间，不再借用 archive 的 id 压级替换。 +``` + +修复缺陷： + +```text +🐛 fix(host): 延迟删除台账只记录根会话 + +台账原先记录整棵树，但启动清扫以根为单位整棵删除，导致子会话被重复 +删除并重复广播 api-session/removed。 +``` + +破坏性变更： + +```text +♻️ refactor!: 行内按钮改用自己的槽位 id + +BREAKING CHANGE: 悬停区布局变化，官方归档按钮回到原来的位置。按住旧 +结构写样式的用户需要调整。 +``` + +纯文档： + +```text +📝 docs: 安装说明改为只走 Git 标签与本地 tgz +``` + +## 工具链提示 + +emoji 在行首是本仓库的有意选择，视觉上整齐。代价是：以类型前缀开头的解析工具（`commitlint`、`semantic-release`、`release-please` 等）会读不到类型。如果以后要接这类工具，有两条路： + +1. 把 emoji 挪到冒号之后（`feat: ✨ 描述`），类型回到行首，规范其余部分不变； +2. 保留行首 emoji，给工具写一个剥掉开头 emoji 与空格的预处理。可用的正则（`\p{Extended_Pictographic}` 已覆盖带与不带变体选择符两种写法）： + + ```text + ^(?:\p{Extended_Pictographic}\uFE0F?\s+)?(?[a-z]+)(?:\((?[^)]*)\))?(?!)?:\s(?.+)$ + ``` + +## 启用提交模板（可选） + +`.gitmessage` 是提交信息模板。启用后每次 `git commit` 会带上前缀提示，删掉不需要的部分即可： + +```bash +git config commit.template .gitmessage +``` + +模板里以 `#` 开头的行会被 git 自动丢弃，不会进入提交信息。只对当前仓库生效；换机器要重新执行一次。 diff --git a/README.md b/README.md index 68054c5..d5f3805 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,8 @@ https://gitea.iwake.top/dsh-plugin/session-delete.git#v2.0.0 DSH 暂不支持插件自动更新，升级就是用新标签重装一次（建议先移除旧版本）。安装或升级后：**宿主半变更需要重启 DSH**（完全退出再打开，仅关闭窗口不一定退出进程）；只改浏览器半时刷新页面即可。 +如果你是在本地开发这个插件（profile 里装的是 `link:` 到工作目录），**光刷新页面看不到改动**：profile 的 `node_modules` 里可能是一份与源码同 inode 的硬链接副本，需要移除再重装一次插件，让 profile 重新取一份。 + ## 兼容性 基于 **DeepSeek Harness 0.2.0-rc.2** 编写。DSH 仍在演进，其它版本与平台组合未逐一验证。 @@ -84,6 +86,14 @@ DSH 暂不支持插件自动更新，升级就是用新标签重装一次（建 - **宿主半**只依赖稳定的服务契约：`sessionQuery`（`traceSession` 取血缘、`listSessions` 取语料）、`sessionPersistence`（含其 JSONL 后端的 `locate()` 诊断钩子，用于定位会话目录）、`workspaceRegistry`、`connection.fetch`（注册受认证的 exact 路由），以及 spill 后端的目录规则。 - **跨半边通信**走 `connection.fetch` 注册的 `POST /api/plugin/session-delete/delete` 与 `.../orphans` 两条路由，浏览器半用文档相对路径请求（支持挂载前缀）。这是静态客户端包与宿主半通信的正规通道；`host.call` 属于动态客户端运行器，不适用于包形式的插件。 +## 贡献 + +提交信息用「emoji + Conventional Commits + 中文描述」，规则、类型表和示例见 [CONTRIBUTING.md](CONTRIBUTING.md)。想省事可以让 git 带上模板： + +```bash +git config commit.template .gitmessage +``` + ## License [MIT](LICENSE)