如何参与贡献
在我们努力使TON 成为最成功的区块链的过程中,使 TON 文档让全世界的人们都理解这一点至关重要。而本地化正是关键,我们很高兴你能加入这个旅程,并朝着相同的目标一起努力。
预备流程
TownSquare Labs 本地化系统向所有人开放!在开始贡献之前,您需要知晓:
- 登录或注册您的 Crowdin 账户。
- 选择您要贡献的语言。
- 请熟悉如何使用 Crowdin指南和翻译风格指南,了解使用技巧和最佳实践。
- 使用机器翻译辅助工作,但不要完全依赖机器翻译。
- 所有翻译结果均可在校对一小时后在网站上预览。
角色
以下是您在系统中可以担任的角色:
- 语言协调员(Language Coordinator) - 管理指定语言的项目功能。
- 开发人员(Developer) - 上传文件、编辑可翻译文本、连接集成和使用API。
- 校对员(Proofreader) - 翻译和批准字符串。
- 翻译员(Translator) - 翻译字符串并对他人添加的翻译进行投票。
我们的本地化项目托管在 Crowdin 上。
Before you start contributing, read the guidelines below to ensure standardization and quality, making the review process much faster.
Side-by-Side Mode
在 Crowdin 编辑器中,所有任务都以side-by-side模式执行。要启用此功能,请单击要处理的文件。在页面右上方,点击Editor view按钮,选择side-by-side模式,以获得更清晰的编辑器视图。
语言协调员(Language Coordinator)
- 翻译和批准字符串
- 预翻译项目内容
- 管理项目成员和加入请求
- 生成项目报告
- 创建任务
开发人员(Developer)
- 上传文件
- 请复制我们的 仓库
- 来到以下文件
src/theme/Footer/config.ts
. - 将变量**
FOOTER_COLUMN_LINKS_EN
** 的值复制到**FOOTER_COLUMN_LINKS_[YOUR_LANG]
**。 - 就如我们在 **
FOTER_COLUMN_LINKS_CN
**中对Mandarin 所 做的那样,您也可以将headerLangKey
和langKey
的键值翻译成您的语言, - 向**
FOOTER_LINKS_TRANSLATIONS
**添加一个新属性:- 将 the key 设置为您的 国际标准组的语言代码 (注意使用两个英语字母, 小写,eg:zh)。
- The value 是您刚刚为您的语言创建的新变量。
- 您可以运行命令
yarn start:local [YOUR_IOS_LANG_CODE]
来预览您的语言的新页脚。
(例如**yarn start:local zh
** 用于预览汉语 页脚) - 如果一切看起来都没问题,请在
i18n_feat
分支上创建一个拉取请求。
- 编辑可翻译文本
- 连接集成(例如,添加 GitHub 集成)
- 使用 Crowdin API
- 使用 Crowdin API
校对员(Proofreader)
作为校对员,您将处理带有蓝色进度条的文件。 点击文件进入编辑界面。
让我们开始贡献吧
-
确保您处于 side-by-side 模式。启用Not Approved过滤,查看需要校对的字符串。
-
请遵守这些规则:
- 选择带有蓝色立方体图标的字符串。检查每个翻译:
- 如果正确,请单击 ☑️ 按钮。
- 如果不正确,请移至下一行。
- 选择带有蓝色立方体图标的字符串。检查每个翻译:
You can also review approved lines:
-
使用Approved过滤选项。
-
如果已批准的翻译有问题,请单击 ☑️ 按钮将其还原为需要校对的状态。
- 要移动到下一个文件,请单击顶部的文件名,从弹出窗口中选择新文件,然后继续校对。
预览你的成果
所有通过审核的内容都将在一小时内部署到预览网站上。请查看我们的仓库,查看最新 PR 中的preview链接。
翻译员(Translator)
作为一名翻译员,您的目标是确保翻译忠实且富有表现力,使其尽可能接近原意并易于理解。您的任务是使蓝色进度条达到 100%。
开始翻译
请按照以下步骤成功完成翻译过程:
-
选择尚未达到 100% 翻译的文件。
-
确保您处于 side-by-side 模式。通过Untranslated字符串进行过滤。
-
您的工作区有四个部分:
- 左上: 根据源字符串输入您的翻译。
- 左下: 预览翻译文件。保持原始格式。
- 右下: Crowdin 建议的翻译。点击使用,但请核实准确性,尤其是链接。
-
点击顶部的Save按钮保存翻译。
-
要移动到下一个文件,请单击顶部的文件名,然后从弹出窗口中选择新文件。
如何添加对新语言的支持
目前,我们在 Crowdin 中提供了所有需要的语言。如果您是社区管理,请按照以下步骤操作:
- 在 TownSquareXYZ/ton-docs 上添加一个名为
[lang]_localization
(例如,韩语为ko_localization
)的新分支。 - 请联系此仓库的 Vercel 所有者,将新语言添加到菜单中。
- 向开发分支创建 PR 请求。请勿合并到开发分支;这仅供预览之用。
完成这些步骤后,您就可以在 PR 请求中看到语言的预览。
当您的语言准备好在 TON 文档中展示时,请创建一个issue,我们会将您的语言设置到生产环境中。