| name | hound-whiteboard-git-convention |
| description | Hound Whiteboard 项目的 Git 提交信息规范。在准备提交时加载。 |
Hound Whiteboard Git Commit Convention
格式
<type>(<scope>): <简短中文描述>
- 详细说明用减号分段(可选)
示例
refactor(creator): 去除 Creator 对本地 BasicObject 实例的依赖
fix(worker-mode): 修复叠帧渲染与框选后修改异常
- ViewportProxy.onRenderFrame 增加 clearRect
- UiRenderer 使用 RectangleRange.fromRectLike 解析 RPC 返回的 bbox
- core-worker 转发 viewport-change.force 标志位
- ViewportCore.flushRenderFrame 恢复 transfer 后的 OffscreenCanvas 内容
perf(rpc): 实现 UI 侧微任务级 RPC 批处理合并
- modifyObject / appendListItem 等高频调用入帧级缓冲
- 同 id 同 key 自动合并
- 微任务 Promise.resolve().then(...) 自动 flush
- 遇到 #call 非批处理调用时先同步清空队列保序
- Worker 侧新增 rpc-batch 消息处理
Type 类型
| 类型 | 何时使用 |
|---|
feat | 新功能、新特性 |
fix | Bug 修复 |
refactor | 代码重构(行为不变) |
perf | 性能优化 |
docs | 文档变更 |
test | 测试相关 |
chore | 构建、配置、依赖等杂项 |
agent | 新增 skill、AGENTS.md |
Scope
Scope 指明变更影响的主要模块/目录。从项目结构和 commit 历史归纳的常用 scope:
| Scope | 对应目录 |
|---|
kernel | src/kernel/(内核层) |
render | src/renderers/(渲染插件) |
host | src/host/(组合根与通道) |
worker-mode | Worker 模式相关(worker/proxy 切换) |
core-worker | src/host/core-worker.js |
board-api | src/host/bridges/ |
creator | src/ui/devices-dag/tools/creator/ |
chooser | src/ui/devices-dag/tools/chooser/ |
modifier | src/ui/devices-dag/tools/modifier/ |
tool | 工具整体或跨工具 |
dag | src/ui/devices-dag/ |
ui-renderer | src/ui/components/renderer/ |
object | src/kernel/objects/ |
demo | src/demo/config/ |
test | 测试修改(不限目录) |
docs | 文档修改 |
benchmarks | benchmarks/ |
编写准则
- 标题 用简短中文描述变更的核心目的
- 正文 用
- 分段列出具体变更点
- 中文描述不加句号
- 标题与正文之间 空一行(单行提交不需要)
- 正文可省略(变更简单的单行提交不需要正文)
- 正文中代码/函数名/类型名保留英文
- 一次提交只做一件事,避免混合多种 type
- 每条
- 描述写在同一行,不换行(正文中如有代码/术语需分行罗列,使用 - 子条目缩进)
- 不用破折号(——):标题与正文都不用,需要补充说明时改用逗号或括号
- 不用
<file>: xxx 前缀:条目直接写变更内容,文件名放在句中自然出现或省略(如「更新操作文档的 WARNING」而非「operation-document.md:更新 WARNING」)
- 标题带动词:中文描述以动词开头或含明确动词(如「实现会话恢复」「修复幽灵选择」),不用裸名词短语