docs(readme): 改写为英文,面向开源读者 - #45
Merged
Merged
Conversation
项目按 Apache-2.0 开源,README 作为门面改用英文。不是逐句翻译原稿 —— 原稿是写给项目内部看的(演示种子怎么换档、临时夹具为什么在),开源读者 先要知道的是「这解决什么问题、凭什么机制解决、怎么跑起来」。 主要改动: - 开头补「为什么存在」三条(口径不唯一、过程不可追、协作靠人盯)与五个 核心机制表,并把范围边界写在明面上:Excel 自由公式与跨表引用不进系统, 这是换取口径唯一的代价,不是遗漏; - 补 8 项发布前完整性检查的清单(原稿没写); - 补 Contributing 与 badge;补一张工作台截图(引用操作手册已归档的那张, 不新增图片文件); - 保留原稿里对贡献者真正有用的部分:演示种子双档案与「换档必须换空库」 那两条、分公司两名账号的由来、临时夹具的删除条件、六个岗位与数据范围 的实现方式。 新增 Internationalization 一节,如实写清英文支持的现状 —— 平台层配了 zh-CN / en,但 en 包只有 7 个对象 32 条 label,zh-CN 是 21 个对象 320 条, 覆盖率约一成;未覆盖的按 fallbackLocale 回落中文,所以切英文是中英混杂, 且视图 / 动作 / 页面 / 看板 / hook 报错文案完全没有英文。把它写成待办与 参与方式,而不是含糊成「支持多语言」。 文档表保留中文文件名(那是真实路径),并注明 docs/ 下全部为中文。 pnpm verify 通过;README 里的相对链接逐条核实存在。 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QhMsYoDpoMGeQLf24eTawP
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
背景
项目按 Apache-2.0 开源,README 作为门面改用英文。
不是逐句翻译原稿。 原稿是写给项目内部看的(演示种子怎么换档、临时夹具为什么还在),开源读者先要知道的是另外三件事:这解决什么问题、凭什么机制解决、怎么跑起来。所以结构重排了。
改了什么
补上原稿没有的
docs/手册/图片/已归档的那张,不新增图片文件)。保留原稿里对贡献者真正有用的
演示种子双档案与「换档必须换空库」那两条、分公司为什么各要两名账号、临时夹具的删除条件(objectstack-ai/objectstack#14547)、六个岗位与数据范围的实现方式(OWD private + 按方案生成的共享规则,而非
hierarchy-security的层级深度)。新增 Internationalization 一节
这一节是这次实测出来的,如实写清英文支持的现状,而不是含糊成「支持多语言」:
zh-CNen平台层是配好的(
objectstack.config.ts里supportedLocales: ['zh-CN', 'en']、fallbackLocale: 'zh-CN'),但 en 覆盖率约一成;未覆盖的回落中文,所以切英文是中英混杂的界面。而且视图页签、动作文案、工作台页面、看板报表、hook 里的三段式报错完全没有英文——元数据 label 本身写的是中文(Field.number({ label: '实际值', … }))。写成待办与参与方式,不当作已完成的能力。
保留中文的部分
docs/下全部为中文;CLAUDE.md(开发约定)未动 —— 本次只要求 README。验证
pnpm verify通过(validate + typecheck + 139 tests + i18n 同步检查);docs/交付/目录)。待决
英文界面要不要做完整,是单独的一笔活(320 条元数据词条 + 视图/页面/看板 + hook 报错文案),建议单开 issue 排期,不混在本 PR 里。
🤖 Generated with Claude Code
https://claude.ai/code/session_01QhMsYoDpoMGeQLf24eTawP
Generated by Claude Code