#翻译

为了让全球用户都能使用灵矶（Tachybase），我们欢迎社区成员参与将文档翻译成不同语言。本指南提供了如何贡献翻译的详细说明。

#当前支持的语言

• 英文 (en)：文档的主要语言
• 中文 (zh)：简体中文翻译

#项目仓库说明

灵矶项目包含两个重要的仓库：

• 文档仓库：tachybase/tachybase-doc - 用于管理和维护所有文档内容
• 代码仓库：tachybase/tachybase - 主项目代码库

翻译工作可以通过以下两种方式进行：

1. 在文档仓库中贡献：这是推荐的方式，适合大多数翻译工作。文档变更会定期同步到主代码仓库。
2. 在主代码仓库中贡献：如果您在贡献代码的同时也想更新相关文档，可以直接在 tachybase 主仓库中进行翻译工作。

根据您的具体情况和贡献内容选择合适的方式。以下说明将涵盖两种贡献方式。

#开始翻译工作

#前提条件

在开始翻译之前，请确保您具备：

1. GitHub 账户
2. Markdown 语法的基本理解
3. Git 工作流程的熟悉度（fork、clone、commit、push、pull request）
4. 英语和目标语言的流利掌握

#翻译流程 - 文档仓库方式

1. Fork 和 Clone：Fork 灵矶文档仓库 并将其克隆到本地机器。

2. 创建分支：为您的翻译工作创建新分支。

   git checkout -b translation-[语言代码]

3. 目录结构：翻译内容按照语言特定目录组织在 docs/ 下：

   • 英文文档位于 docs/en/
   • 中文文档位于 docs/zh/
   • 如果需要其他语言，请创建相应的语言目录（例如，日语为 docs/ja/）

4. 文件结构：保持与英文文档相同的文件结构。例如，如果您要翻译 docs/en/guides/introduction.md，则应创建 docs/[语言代码]/guides/introduction.md。

5. 元数据：确保 _meta.json 文件也被翻译，以便正确导航。

#翻译流程 - 主代码仓库方式

1. Fork 和 Clone：Fork 灵矶主代码仓库 并将其克隆到本地机器。

2. 创建分支：为您的翻译工作创建新分支。

   git checkout -b docs-translation-[语言代码]

3. 进行翻译：遵循与文档仓库相同的文件组织原则进行翻译工作。

#翻译指南

#基本原则

1. 保持技术准确性：确保技术术语和概念被准确翻译。
2. 文化考量：在必要时调整示例和解释，使其在文化上适当。
3. 一致性：在整个翻译中使用一致的术语。
4. 保持原始格式：保留 Markdown 格式、代码块、链接和其他结构元素。

#具体指南

1. 代码示例：除非代码包含注释，否则不要翻译代码示例。只翻译注释部分。

   // 这个注释应该被翻译
   const example = 'Do not translate this string';

2. 技术术语：如果某些技术术语在您的语言中通常使用英文，可以考虑保留英文，但在第一次出现时在括号中提供翻译。

3. 链接：更新内部链接，使其指向页面的翻译版本（如果有）。对于指向代码仓库的链接，请确保它们指向正确的位置。

4. 截图：如果截图中包含文本，请考虑创建一个带有您语言文本的版本。

#提交您的翻译

#提交到文档仓库

1. 提交更改：使用描述性消息提交您的更改。

   git commit -m "添加[语言]翻译：[具体内容]"

2. 推送并创建 Pull Request：将更改推送到您的 fork 并创建一个 Pull Request 到灵矶文档仓库。

   git push origin translation-[语言代码]

   然后在 GitHub 上创建一个从您的 fork 到 tachybase/tachybase-doc 主分支的 Pull Request。

#提交到主代码仓库

1. 提交更改：使用描述性消息提交您的更改。

   git commit -m "docs: 添加[语言]翻译：[具体内容]"

2. 推送并创建 Pull Request：将更改推送到您的 fork 并创建一个 Pull Request 到灵矶主代码仓库。

   git push origin docs-translation-[语言代码]

   然后在 GitHub 上创建一个从您的 fork 到 tachybase/tachybase 主分支的 Pull Request。

3. 审核流程：您的翻译将由项目维护者以及可能的其他语言使用者进行审核。请准备好根据反馈进行修改。

#维护翻译

文档会随着时间不断发展。为了保持翻译的最新状态：

1. 关注相关仓库：根据您的贡献方式，关注文档仓库或主代码仓库，及时获取英文文档更改的通知。
2. 定期更新：定期检查英文版本是否已更新，并相应地更新您的翻译。
3. 同步上游变更：在开始新的翻译工作前，确保您的 fork 已与上游仓库同步。

#仓库间的同步

请注意：

• 文档仓库中的内容会定期同步到主代码仓库
• 主代码仓库中的文档改进也会同步到文档仓库
• 如果您不确定在哪个仓库贡献，可以选择文档仓库，这通常是处理纯文档翻译的首选方式

#翻译状态

我们维护了一个需要翻译或更新的文档列表。查看两个仓库中标有"translation"标签的 issue，找到需要关注的文档。

#跨仓库协作

有时文档需要参考代码仓库中的内容。如果您需要：

1. 引用代码示例：请引用稳定分支中的代码，并明确指出代码来源自主仓库。
2. 新功能文档：对于尚未发布的新功能文档，请与主仓库的开发者协调。

#问题或需要帮助？

如果您对翻译流程有疑问，请随时：

• 在文档仓库或主代码仓库的 GitHub 上开一个带有"translation"标签的 issue
• 联系文档维护者或项目维护者

感谢您帮助灵矶面向全球用户！