Skip to content

docs(README): 校准 README 真实性并重构为中英双语(根英文 · 中文迁入 i18n) - #51

Merged
ThreeFish-AI merged 2 commits into
feature/1.x.xfrom
ThreeFish-AI/veracity-attestation-readme-i18n
Jul 4, 2026
Merged

docs(README): 校准 README 真实性并重构为中英双语(根英文 · 中文迁入 i18n)#51
ThreeFish-AI merged 2 commits into
feature/1.x.xfrom
ThreeFish-AI/veracity-attestation-readme-i18n

Conversation

@ThreeFish-AI

Copy link
Copy Markdown
Owner

背景与动机

Hyper Git 是已发布的 VS Code 扩展(v0.0.9,publisher ThreeFish-AI),根 README.md 是 Marketplace / OpenVSX 市场页与仓库首屏的第一事实源。本次对其执行真实性校验(veracity-attestation)并重构为中英双语:根路径用英文以提升国际可发现性,中文版沉淀至 docs/i18n/zh-CN/README.md 保持可维护。

真实性校验结论

3 路只读核验 + 单元测试实跑取证,README 整体高可信(抽样 8 项确认属实),校正 4 处陈述漂移:

原陈述 校正为 取证
架构分层 engine/ → adapter/ → ui/ engine/ → adapter/(含自绘 adapter/webview/)——src/ui/ 实不存在 顶层目录扫描
单测计数 280 例 324 例(以 vitest 实跑为准,非 grep 估算) pnpm run test:unit
CodeLens 标签 「提交此 Hunk」 运行时英文「Commit this Hunk」 inline-commit-codelens.ts:56
vsce 段落 围栏内伪标题 + <publisher id> 占位 结构理顺 + 真实 publisher ThreeFish-AI package.json

取证纠偏:grep 曾估算 325,最终以 vitest 实跑的 324 为准。

变更内容

  • README.md(根):改写为地道英文版(意译而非直译),落实全部校正 + 顶部能力规模行(6 views · 97 commands · 6 settings · 324 unit tests)。
  • docs/i18n/zh-CN/README.md(新增):中文校正版,11 条相对链接按 3 层深度重算并逐一 test -e 校验通过。
  • 两版顶部互加语言切换,双向可跳转。
  • 补阙:README 补入既有但未引用的 CHANGELOG.md 链接。
  • 同步索引与过时项校正knowledge-map.md 新增中文 README 条目,并据 agent/index.ts 权威导出校正 agent/ 接缝清单(补 ICommitMessageProvider、移除规划中的 IChatToolRegistrar、标注 5 接口均 Null 实现);docs/README.md 发布说明「最新」指针 v0.0.6 → v0.0.9。

验证

  • ✅ 单元测试 324 全绿(纯文档变更,零回归)
  • ✅ 两版 README + 索引所有相对链接目标存在(test -e 校验通过)
  • ✅ 无 bash 围栏内伪标题、无 280/325 残留、badge 图片 URL 未改
  • ✅ 语言切换双向可跳转

影响面

仅文档变更,不触碰任何源码,无功能与构建影响。

🤖 Generated with Claude Code, CodeX, Gemini

- 真实性校正(经 3 路只读核验 + 单测运行取证):
  - 架构分层修正——移除不存在的 ui/ 层,改述为 engine/ → adapter/(含自绘 adapter/webview/ UI);
  - 单元测试计数以 vitest 实跑为准修正为 324 例(原 280 过时);
  - 行级提交 CodeLens 标签校准为运行时英文 "Commit this Hunk";
  - vsce 段落理顺(避免 bash 围栏内伪标题),publisher 占位符落实为真实 ThreeFish-AI;
  - 顶部补入已核验能力规模行(6 视图 · 97 命令 · 6 配置项 · 324 单测)。
- 双语重构:根 README.md 改写为地道英文版;中文版迁入 docs/i18n/zh-CN/README.md 并重算相对链接;两版顶部互加语言切换。
- 补阙:README 补入既有但未引用的 CHANGELOG.md 链接;知识索引 knowledge-map.md 同步新增中文 README 条目。

🤖 Generated with [Claude Code](https://github.com/claude), [CodeX](https://openai.com), [Gemini](https://github.com/apps/gemini-code-assist)
Co-Authored-By: Aurelius Huang<threefish.ai@gmail.com>
- docs/README.md:发布说明「最新」指针由 v0.0.6 更新为 v0.0.9(与 releases/README.md 版本索引及 knowledge-map 口径统一);
- docs/.agents/knowledge-map.md:agent/ 接缝清单据 agent/index.ts 权威导出校正——补入已实现的 ICommitMessageProvider、移除尚属规划的 IChatToolRegistrar(改注为规划中第 6 接缝并链至调研报告),并标注当前 5 接口均为 Null 实现。

🤖 Generated with [Claude Code](https://github.com/claude), [CodeX](https://openai.com), [Gemini](https://github.com/apps/gemini-code-assist)
Co-Authored-By: Aurelius Huang<threefish.ai@gmail.com>
@ThreeFish-AI
ThreeFish-AI merged commit a669596 into feature/1.x.x Jul 4, 2026
5 checks passed
ThreeFish-AI added a commit that referenced this pull request Jul 4, 2026
…ELOG; (#58)

- package.json version 0.0.9 → 0.0.10(方案 A:纯 major.minor.patch,由 --pre-release 标志发预发布,规避 VS Code Marketplace 不接受 -rc.N semver 后缀的限制);
- 新增 docs/releases/v0.0.10-rc.1.md(文件名精确匹配 tag ref_name,作 GitHub Release 正文单一事实源),归纳 v0.0.9→HEAD 真实变更:Graph 视图对齐官方 (#53)、悬浮浮层 iframe 裁剪修复 (#53)、未提交角标承载迁移 (#52)、README 双语与真实性校准 (#51);
- CHANGELOG 新增 [0.0.10-rc.1] 段(遵循 Keep a Changelog);
- 本版作为 VS Code Marketplace 发布链路打通的验证版(首次以 vsce publish --pre-release 于 Marketplace/OpenVSX/GitHub Release 三渠道并发)。

🤖 Generated with [Claude Code](https://github.com/claude), [CodeX](https://openai.com), [Gemini](https://github.com/apps/gemini-code-assist)
@ThreeFish-AI
ThreeFish-AI deleted the ThreeFish-AI/veracity-attestation-readme-i18n branch July 4, 2026 08:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant