Skip to content

EIPs 中文新手翻译指南

izayl edited this page Nov 9, 2021 · 3 revisions

注 1:本教程主要面向新接触 GitHub 的译者们,为了更方便的完成翻译任务而写。注意,本教程基于 GitHub 网页版操作。 注 2:本教程参考自 掘金翻译计划

1. 认领任务

先在 issue 列表 中认领自己想翻译的 EIP,如果列表中没有,你可以新建一个 issue。 认领的作用主要为了避免重复工作,当你看到别人认领了这个 EIP,可以看看其他需要翻译的 EIP。 超过 2 周没有更新的 issue 将会认为是 stale(过期) 的,其他译者可以继续接手这个 EIP 进行翻译。

2. Fork 此项目

注意:如果你之前有 Fork 过,在开始新的翻译之前先同步一下此仓库,否则可能无法找到认领的文章。

操作如图,如果按钮可点击,说明需要进行同步,保证和本仓库的内容一致。

访问 本项目地址,点击右上角的 Fork 按钮,将本仓库 Fork 到你自己的账号。 fork

3. 进入 Fork 的仓库主页

回到自己的 GitHub 主页,并找到刚刚 Fork 过的 EIPs 仓库,进入仓库主页。

4. 新建 branch

现在你需要新建一个用于翻译一篇文章的 branch,先用鼠标左键单击 1 号箭头指向的位置,然后在 2 号箭头指向的地方填写新分支名称,我们推荐的新分支名格式为:zh/EIP编号(比如 zh/eip-20)填写好后就会出现如 3 号箭头所示的东西,这时用鼠标左键单击它,新 branch 就建立好了,并且现在已经自动跳转到了这个新的 branch 上。

注:新建的分支用于进行翻译以及提交翻译。master 分支用于与此 EIPs 仓库进行同步更新。

5. 找到要翻译的 EIP

所有的需要翻译成中文的 EIP markdown 源文件都在 EIPS/zh 目录下,可以在这个目录下找到你需要翻译的 eip 源文件,所有的 eip 都是按 eip 编号来命名的。比如,EIP-20 的文件位于 EIPS/zh/eip-20.md

你也可以直接通过 GitHub 的搜索功能快速查询:

方法 1,通过 Go to file 查询,点击放大镜,然后输入你想翻译的文件路径,比如 /EIPS/zh/eip-20.md

方法 2,通过 Command Palette 查询,直接通过快捷键 ⌘ + K ( Windows 下 使用 Ctrl + K )唤出控制面板,输入你想翻译的文件路径,比如 /EIPS/zh/eip-20.md

6. 进行翻译

点击铅笔按钮,进行编辑,英文原文不需要保留

image

7. 保存翻译

翻译一次可能翻译不完,可以通过提交 commit 的方式,保存本次修改, 在 1 处填写此次 commit 修改的简述标题,2 处填具体详情(可选),3 处选择第 4 步中我们创建的新分支,最后点击 4 处的按钮

8. 发起 Pull Request

以上的修改都是在你 Fork 的仓库内进行的,如果需要将你的翻译同步到 https://eips.ethlibrary.io/zh/ 的网站上,需要你提一个 Pull Request 到 ethlibrary/EIPs 的仓库中,让你修改的内容 merge 到源内容仓库中。

点击 Pull Requests 菜单,然后再点击图中的 new pull request 按钮

然后就会自动跳到如下页面

image

1 处默认应该 master,如果不是的话需要修改成 master; 2 处默认应该是你当前修改的分支,比如这里的 zh/eip-20,如果不是,需要手动点击选择你本次修改的分支; 3 处填写本次你翻译的标题,格式为 doc(zh): eip 编号 4 处选填,具体翻译了哪些内容,哪些觉得没翻译好,需要帮助之类的都可以写 5 处在上面都填写完成之后,点击这个按钮,完成 Pull Request 的请求

8. 接受 Review

审核人员将会对你提交的翻译进行 Review,可能会提出修改建议,等建议修改完善之后,审核人员确认你的翻译准确之后,将会通过你的翻译。 系统会自动将你的翻译内容发布到 https://eips.ethlibrary.io/zh/

Clone this wiki locally