SuperAPI AI 工具集

house-rules

写作与研究

查看项目

更新于 11-06 20:11

技能介绍

house-rules 是 scarletkc/Hatoba 项目的规范文档,记录所有者(owner)对仓库各项事务的要求,这些要求并未写在仓库的其他文件中。它面向为该仓库做贡献的开发者和 AI 助手,给出判断标准与决策规则。

用途与范围 文档覆盖 UI 文案、翻译、文档、助手提示词与工具描述、界面外观与行为,以及提交、拉取请求、审查机器人和合并等发布流程。

主要约定 文案与 UI:以同类现代应用的做法为准,再自行判断;按钮和菜单项不带省略号(进度文本和占位符除外);不添加“已迁移至此”类提示或迁移说明;每句文案需在所有状态、模式和平台上成立;只写用户可见的内容,发布说明不提提示词重写或重构。英文文案对按钮、菜单项、标签页、区块标题、名词短语式设置标签和操作性对话框标题使用 Title Case,对开关标签、选项、工具提示、状态行、空状态和疑问式标题使用 sentence case;网站按钮与链接用 sentence case。不使用长破折号、感叹号、“please”或“we”。标签需说明发生什么且不与相邻标签雷同。删除确认只需说明不可撤销。

翻译:zh-TW 按台湾用法撰写而非转换,使用「」引号与台湾术语(連線、終端機、連接埠轉送、工作階段),OpenCC 最多只作初稿。面向开发者的错误保留英文,如 AppError.detail 和 MCP 服务器消息;要么整族错误都翻译,要么都不翻译。各语言排版一致,CJK 词内不换行。

助手提示词与工具描述:提示词承载上下文、如何选择工具及跨工具规则;工具描述承载工具功能、带确切数字的限制、前置条件和失败处理;允许值列表放入 schema;两处不重复。每条陈述需在所有权限模式下成立,提示词不写由用户设置决定的值。不用 IMPORTANT、MUST 或大写强调,不按模型分设提示词变体。只解释处于激活状态的内容。名称与参数符合模型预期,一个概念用一个词。提示词变更需源于真实模型错误、虚假陈述或重复事实。

文档:内置 hatoba 技能不点名外部工具或替代方案;README 唯一媒体是宣传视频,不放截图、不翻译 README、不链接政策文件。定位文案(标语、README 引言、网站标题、仓库描述)不对 AI 提供方式作承诺。文档不记录验证状态,需向所有者确认已检查内容。

外观与行为:状态变化不改变尺寸;按钮不承载状态,进度放在状态行;优先复用已有模式;AI 界面遵循 Claude Code 和 Codex;遵循平台惯例,macOS 无托盘图标,菜单行为如原生,Ctrl 加鼠标滚轮改变终端字号而非窗口字号。

决策与询问 自行决定并在 PR 或回复中用一行说明选择:所有语言的全部措辞、布局与交互细节、两个合理选项间的取舍。不要让所有者判断截图或从选项中挑选。定位文案、以所有者名义发布的内容、偏离同类应用做法、产品范围变更(增删设置页、功能或入口)需先询问所有者。外部贡献者的 PR 不涉及文案、翻译、文档、提示词或 UI 外观;若审查后仍有问题,保留其逻辑并在所有者 PR 中重写用户或模型可见内容,注明 Co-authored-by。

发布流程 长任务在里程碑完成时提交检查点。PR 正文用几句话说明改了什么和为什么,因为其将逐字成为 squash 提交正文;跳过 PR 模板和清单。分支提交不带 AI 共同作者 trailer。CodeRabbit、Devin Review 和 Codex 各自审查 PR,CI 决定合并而非机器人。修复真实用户或维护者可能遇到的问题,其余在讨论中说明理由后解决;修复后最多再请求一次 @codex review。在 GitHub 上的评论用所有者口吻,第一人称,无 AI 署名。代码移动会重开在旧路径已驳回的 CodeQL 告警,需请所有者以原理由驳回。合并需等待 CI,仅改 Markdown 的 PR 可立即合并;用 gh pr view <n> --comments 阅读评论;用 gh pr merge --repo scarletkc/Hatoba <n> --squash --admin 合并,因规则集要求所有者自己的 PR 得不到的批准。自行创建的 worktree 需清理,Windows 上还需 Remove-Item -LiteralPath <path> -Recurse -Force 和 git worktree prune,再 git branch -D <branch>;应用为会话创建的 worktree 保留,归档会话时自动清理。

适用场景与限制 适用于为 scarletkc/Hatoba 做贡献或维护其 AI 助手行为的人员。文档未提供收费、平台支持范围或效果数据等信息。