Skip to content

docs: 补充 Windows 需要开启开发者模式的前置条件 - #99

Open
RXQ6 wants to merge 2 commits into
helsome:mainfrom
RXQ6:docs/windows-dev-mode-prereq
Open

RXQ6 wants to merge 2 commits into
helsome:mainfrom
RXQ6:docs/windows-dev-mode-prereq

Conversation

@RXQ6

@RXQ6 RXQ6 commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

改动说明

在 README 的「面向开发者 → 前置条件」中补充 Windows 需要开启「开发人员模式」。

Windows 未开启开发者模式时,Bun 无法创建符号链接,bun install 会在 node_modules 下留下空目录且不生成 .bin,导致 bun run typecheck 找不到 tsc,测试也无法运行。当前前置条件只列了 Bun、Longbridge CLI 与 LLM 提供商,Windows 贡献者第一次上手会卡在这里且难以自诊断。

中文版(README.md / README.zh-CN.md)与英文版(README.en.md)同步修改,三份 README 措辞一致。

关联 Issue

无(纯文档改动)

测试报告(正式审核前必填)

环境

  • Bun:1.4.2
  • OS:Windows 11

实际执行命令与结果

本次为纯文档改动,仅修改 README.md、README.zh-CN.md 与 README.en.md 的前置条件说明,不涉及运行时行为、类型或测试变更,故未运行测试套件。

改动依据:结论来自在 Windows 未开启开发者模式环境下的实际观察——bun install 完成后 node_modules 下存在空目录、.bin 未生成,bun run typecheck 无法找到 tsc

已知失败 / Baseline(如有)

  • 已提供实际测试命令与 pass/fail 结果
  • 已说明测试环境
  • 如果存在已知 baseline / 环境失败,已提供 main 对照或说明
  • 核心改动已有对应 focused test / smoke / integration 验证

UI 截图(仅可见 UI 变化时必填)

  • 本 PR 无可见 UI 变化(无需截图)

Scope / 后续

仅补充前置条件说明,无代码改动;三份 README 同步更新,各 +2 行。

@helsome helsome left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

补这个 Windows 前置说明是有价值的,但 README 现在写成“否则 Bun 无法创建符号链接”过于绝对。Windows 的 symlink 权限并不只取决于 Developer Mode:Developer Mode 允许非提升进程使用 unprivileged symlink creation;具备相应权限/提升运行的进程也可能创建 symlink。因此建议把措辞收窄成项目实际需要的场景,例如:

Windows:建议在普通(非管理员)开发终端下先开启 Developer Mode。否则本项目使用 Bun 安装 workspace/symlink 依赖时可能出现 node_modules 空目录、缺少 .bin、tsc not found 等问题。

英文同步表达即可。这样既保留作者真实复现到的故障,又不把 Windows 平台行为写成普遍定律。该 PR 目前也已与 main 冲突;改完文案后顺手 rebase 即可,不需要补运行时测试。

@RXQ6
RXQ6 force-pushed the docs/windows-dev-mode-prereq branch from 519e5fc to 078e751 Compare September 14, 2026 05:31
@RXQ6

RXQ6 commented Sep 14, 2026

Copy link
Copy Markdown
Contributor Author

@helsome 已按你的建议收窄措辞(中文/英文版同步),并已 rebase 到最新 main,冲突已解决,当前 diff 仅新增 README.md / README.en.md 各一段 Windows 前置说明。方便时再看一眼,谢谢!

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.

3 participants