贡献 MDN Web 文档的翻译内容
???? 首先,感谢您抽出时间为 MDN Web 文档的翻译内容做贡献! ????
以下是一系列关于向 MDN Web 文档翻译仓库贡献翻译内容的指导原则,该仓库托管在 GitHub 上的 MDN 组织中。
同行指南可在这里找到.
语言环境
在我们继续之前,您应当知晓我们只接受对活动语言环境的更新——这代表该语言环境有活跃的社区维护团队来审核拉取请求、修复问题、进行更新等。目前活动语言环境的列表如下:
fr
ja
ko
pt-BR
ru
zh
(zh-CN
and zh-TW
)
如果你只是想查找并跳转到一个任务,可以按格式 “l10n-<语言环境小写形式>”在这个仓库的issues list或主内容仓库 issues中按标签搜索。
行为准则
每个参与这个项目的人都应该遵循我们的行为准则。
许可证
在对内容做出贡献时,您同意根据我们的许可证许可您的贡献。
做出贡献
一个了解向 MDN Web 文档贡献的一般准则的好地方是MDN 内容和样式指南。
例如,您可以通过文档写作规范了解更多有关 MDN 写作风格指南的信息。
开始编辑
此仓库具有与内容仓库完全相同的目录结构、概念和适用于仓库的命令。内容仓库托管了所有 MDN 的英文内容,主要的不同在于您开始编辑前的准备工作。它们大部分是相同的,但这里需要更加注意。
首先,获取所需的基本工具和配置,可参见内容仓库构建部分。
(译者注:继续往下看就好。)
现在你需要复刻(Fork)并克隆(Clone)内容仓库和翻译内容仓库(此仓库)。
内容仓库准备工作
-
一旦上述工作完成,cd 到内容仓库。
-
运行命令 yarn install
来查找最新的包并获取本地 MDN 测试环境,
推荐您在每次对 source 做出更改前都运行一次 yarn install
命令来确保您的包保持最新。
-
接下来,创建一个名为 CONTENT_TRANSLATED_ROOT
的环境变量,
它指向翻译内容仓库的 files
目录。
您可以为单个绘画执行如下操作:
export CONTENT_TRANSLATED_ROOT=/path/to/translated-content/files
但是你每次打开终端窗口时都必须重新设置。然而,您可以将环境变量设置放在位于内容仓库根目录下的 .env
文件中。可使用下面的命令完成这个操作:
echo CONTENT_TRANSLATED_ROOT=/path/to/translated-content/files >> .env
(如果 .env
文件尚不存在,则会为您创建该文件。)
-
现在你已经完成设置,键入命令 yarn start
启动运行在 localhost:5000
的本地测试服务器。
在翻译内容仓库中工作
在翻译内容存储库中,决定要进行哪些更改,然后:
-
创建一个新分支以在其中进行所需更改。
-
切换到新的分支,进行想要的更改,你可以继续回到 localhost:5000/<你的语言环境>
(例如 localhost:5000/zh-CN
访问简体中文版本)来测试你的更改并确保内容按你所期望的样子呈现。
-
当您对您的更改感到满意,创建一个拉取请求,我们的一个审核团队将对其进行审核。
-
一旦拉取请求被合并,版本更新需要花费 48 小时(每日构建和 CDN 缓存)。
要查看你的更改是否已被部署,你可以查看 What’s Deployed。
有关编辑此存储库的更多信息
有关更多信息,我们建议您访问 内容存储库。
并阅读其 README 文件,特别是了解 基本概念,
拉取请求礼仪,
以及常见的操作,例如 添加,
移动,或
删除 文档。