OSS 项目

开源项目通常从一个 README 文件开始。

随着社区的壮大，来自不同国家的贡献者会请求翻译。 手动维护 README.ko.md、README.fr.md 及其他语言文件很快变得困难。

Localizeflow 通过拉取请求自动保持您的 README 和文档同步，无需更改您现有的工作流程。

前提条件

• 一个 GitHub 账户。
• 对您要翻译的 GitHub 组织或仓库的访问权限。

准备您的仓库（可选）

如果您已经维护手动翻译（例如 README.ko.md 或 docs/ja/）， 请在启用自动化之前将它们删除，以便您的默认语言保持为唯一可信源。

---

登录并安装 Localizeflow GitHub 应用

1. 访问 localizeflow.com。

2. 使用 GitHub 登录。

3. 选择 Install in new account。

4. 选择您要安装 Localizeflow GitHub 应用的账户——您的个人账户或您管理的组织。

   在 GitHub 组织中安装此应用需要组织所有者权限。 如果您不是所有者，请将此页面分享给所有者，并请他们为您完成安装步骤。

5. 选择您希望 Localizeflow 访问的仓库，然后选择 Save。

6. 您将被重定向到 Localizeflow 仪表盘。

将仓库连接到 Localizeflow

1. 在 Localizeflow 主页，选择 + Connect repositories。

2. 选择一个或多个仓库，然后选择 Save。

3. 已连接的仓库会显示在 Home 和 Repositories 页面。

---

运行您的首次翻译

连接仓库后，从仪表盘选择仓库以打开入门向导。

该向导不到两分钟，定义：

• 哪些语言
• 必须保持不变的术语

---

第 1 步：语言与目标分支

目标语言

选择一个或多个目标语言。
Localizeflow 会为每种选中的语言生成并维护拉取请求。

您可以稍后从仓库设置中修改语言。

目标分支

选择翻译拉取请求应打开的分支。

• 大多数情况下，使用默认分支（例如 main）。
• 如果您使用预发布或文档分支，请选择该分支。

如果留空，Localizeflow 会使用仓库的默认分支。

选择 Continue。

---

第 2 步：输出位置

选择项目类型

大多数开源仓库由以下内容组成：

• 根目录的 README.md
• 简单的 docs/ 文件夹
• 基于 Markdown 的内容，无文档框架

选择：

• 简单仓库

翻译选项

您可以启用额外处理：

• Markdown（默认）
• 图片翻译（测试版）（文档站点不可用）
• 笔记本翻译
• 在翻译中添加免责声明

对于大多数开源项目，我们推荐：

• 仅 Markdown （针对以 README 为重点的仓库）
• Markdown + 笔记本翻译（如果项目包含 Jupyter 笔记本或示例）

这样让面向社区的文档易于访问，同时不会增加维护负担。

选择 Continue。

---

第 3 步：术语表与最终检查清单

自动化开始之前，您可以定义翻译时必须保持不变的术语。

创建术语表（推荐）

术语表有助于保留：

• 产品名称
• 公司名称
• 功能名称
• 法律或合规短语

每行添加一个术语。生成的翻译中，这些术语保持不变。

示例：

Localizeflow
Co-op Translator
GitHub App

您可以稍后编辑或附加更多术语表。

---

最终检查清单

在选择 Save & Finish 前，请确认：

• 源路径与您的 Markdown 文件位置匹配正确。
• 现有手动翻译不会与生成内容冲突。
• 如果需要，旧的翻译文件夹已被删除。

此检查可防止文件重复和链接错误。

---

开始自动化

选择 Save & Finish 后，您将被重定向到仓库详情页面。

翻译不会自动开始。

要启动自动翻译：

1. 选择 Automate。
2. Localizeflow 扫描您的仓库。
3. 生成翻译任务。
4. 自动打开草稿拉取请求。

自动化默认处于禁用状态。

启用后，每当您的源 README 或文档发生变化时，Localizeflow 会自动打开和更新翻译拉取请求。

贡献者可以像审查其他拉取请求一样审查翻译变更。

您可以随时通过 Pause automate 暂停自动化。