Fankouzu/solana-basic-ui

🔥【必看】翻译流程说明

Fankouzu opened this issue · 1 comments

翻译流程

此流程遵循标准的 Github Flow,如已了解可直接略过。
image

整个翻译流程分为以下几个阶段:

  • 认领阶段
  • 翻译阶段
  • 校对阶段

认领阶段

如未认领文档就直接翻译,容易出现撞车的情况。翻译任务认领说明

因此,在翻译前务必进行任务认领。

认领任务,请到 Github Issues 选择想翻译的文档。

选定要翻译的文档后,即可开始翻译。

翻译阶段

文件名是用和官方文档一致的文件名,井号级别也要一致。

翻译过程中,请注意格式和内容的准确性。

fork 并 clone

先将 Fankouzu/solana-basic-ui 的文档仓库 fork 为个人仓库(有增删改的权限)。

将 fork 后的仓库 download 至本地,如:

git clone https://github.com/<YOUR-GITHUB-NAME>/solana-basic-ui/

如下载过程过慢,可使用 depth 忽略以往的提交,这里不做过多赘述。

请基于 main 分支创建你的翻译分支(目的是,保证 main 分支与主仓库内容始终一致)。

例如:

git checkout -b <翻译分支> main

翻译

ps: 在开始翻译前,请务必先了解中文排版说明。

在 clone 好的文档中找到你所认领的文章,即可开始翻译。

注意:
不同的官方文档要放到对应的目录中,文件名和官网文件名一致

翻译完成后,请 push 至个人仓库。

git add
git commit -m 'Docs: 翻译的哪篇文章'
git push -u origin <翻译分支>

再创建 Pull Request 至 Fankouzu/solana-basic-ui 仓库。

注意:在创建 Pull Request 时,请尽量勾选允许其他人进行修改,便于快速修改及合并。

至此翻译阶段就结束了。

校对阶段

翻译完成请评论 @校对者

校对中,如有疑问或翻译错误,校对者会给出建议。

Github 的 PR 的评论提供了 suggestion 的功能,校对者对某行给出校对建议后,如无异议,可以直接进行合并。

而如果改动点较多,需进行本地修改时,则在本地对对应的内容进行修改,并提交到个人仓库的翻译分支即可。

注意: 无需关闭 Pull Request,Pull Reuquest 会自动追踪你的修改。

完成

校对完成后,校对者会对 PR 进行 Approve 操作,并进行 Pull Request 的合并。

当你的 Pull Request 被合并后,则代表流程结束。

其他

如需再次翻译,或同时翻译多篇。

  • 一次 pr 尽量只有一篇文章的翻译,便于回溯
  • 保证个人仓库的 main 分支始终为最新
  • 每次翻译新文章时,请基于 main 分支拉取新分支
    更新个人仓库的分支
git remote add upstream https://github.com/eslint/cn.eslint.org.git
git fetch upstream
git checkout main
git merge upstream/main

翻译流程

128540730-cb796f56-e787-44f5-b716-e6c77dcbc2f7

崔老师, 好的, 收到