Contribute

如何参与

作者Changkun Ou

阅读时长约 3 分钟

发现内容有误或难以理解时，请使用出现问题的章节底部的「提交问题」。该链接会自动带上章节标题和公开网址，让报告从准确位置开始。如果更正方法已经明确，可以使用旁边的「编辑本页」。GitHub 会打开对应的 .qmd 源文件，并引导你把修改提交为拉取请求。

源码仓库包含中英文正文、参考文献条目、图示源文件、阅读器、构建流程和服务器。英文或中文都可以用来提交报告。即使只发现了内容缺口，暂时没有最终措辞或实现方案，这份报告仍然有价值。

哪些反馈最有帮助

事实错误。 指明错误主张；如果能找到一手资料，也请一并提供。研究论文、正式规范、监管机构文件、产品文档或发布说明，通常比没有给出来源的二手摘要更可靠。
过期的数字或名称。 价格、上下文上限、基准结果、模型名称、法律和产品行为都可能变化。请提供替代值适用的范围，以及对应的发布日期或版本发布日期。
难以理解的段落。 指出解释从哪里开始难以跟上。原因可能是缺少定义、隐含前提没有写明、不同层次之间跳得太快、公式没有定义符号，或示例无法支持周围的主张。
展示或实现故障。 错别字、失效链接、公式无法渲染、图示被截断、控件无法无障碍使用、移动端横向溢出，以及阅读器、构建流程或工具中的缺陷，都属于处理范围。
中英文版不一致。 两个版本应当保留同一项技术主张，以及相同的章节结构、来源、公式与图示含义。它们并非逐句对应的副本，每个版本都应使用本语言最自然的表达。

一份便于处理的问题报告至少应包含：

对于仍在变化的线上主张，请分别写明资料的发布日期和访问日期。当前网页可能已经不同于章节引用它时的内容。如果两份可信资料得出不同结论，请同时提供，不要把其中一项直接写成定论。

小范围更正可以直接使用「编辑本页」，它会在 GitHub 编辑器中打开准确的源文件。请只修改解决问题所需的内容，在拉取请求中说明修改前后的含义，并附上证据。不要修改 _book/，该目录由构建流程生成。

较大的改动请先阅读仓库的贡献指南，其中列出了源码结构、本地工具和构建命令。除非改动本身需要迁移，否则应保留固定标题、小节标识符、交叉引用、引用键、图示标识符和可运行接口。

内容修改必须同时更新两个语言目录。这里要求的是技术内容一致，而不是直译：两个版本应保留相同的主张、证据、结构、公式和示例，同时分别使用自然的英文与中文。如果目前只能更正一个语言版本，请提交附有证据的问题报告，不要把文字机械复制到另一个版本。

请求审阅之前，请按贡献指南运行相关本地检查。持续集成会先运行 lint，构建中英文版，然后执行 Bun 内容与阅读器测试及 Go 路由测试。如果任一语言无法编译、内部链接失效、引用找不到参考文献条目，或固定网址改变却没有重定向和回归测试，改动就还不能提交审阅。

公开内容采用 CC BY-NC-ND 4.0 许可。该许可允许署名的非商业分享，但不允许公开分享改编版本。它并不妨碍著作权人在本仓库中继续维护规范版本。

仓库的贡献政策接受更正、澄清与修复，但不接受没有指出具体问题的主动改写。如果改动超出这一范围，请先提交问题，说明它要解决的事实、解释、结构、无障碍或渲染问题。