Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

参与翻译 #4

Open
justjavac opened this issue Apr 14, 2020 · 1 comment
Open

参与翻译 #4

justjavac opened this issue Apr 14, 2020 · 1 comment
Assignees

Comments

@justjavac
Copy link
Member

justjavac commented Apr 14, 2020

首先,感谢你参与本文档的建设。

本文是一篇针对首次参与开源项目的开发者编写的一份简易教程,本文档更偏重于翻译文档而非贡献代码。

1. fork 仓库

大部分情况下,你是没有本仓库的 write 权限的,因此你需要 fork 本仓库。

点击右上角的 fork 按钮。你的本地仓库地址是:

https://github.com/xxxxxx/typedoc

其中 xxxxxx 是你的用户名。

2. clone 到本地

注意,千万不要 clone 这个仓库(denodev/typedoc),因为你没有 push 权限。你需要 clone 自己已经 fork 完的仓库。

有 2 种 clone 方式:HTTPS 和 SSH。推荐使用 SSH 方式,这需要你先添加 [SSH keys]((https://github.com/settings/keys)。

git clone git@github.com:xxxxxx/typedoc.git

其中 xxxxxx 是你的用户名。默认分支为 master

如果你想长期参与本项目,推荐你添加一个针对上游仓库(denodev/typedoc)的跟踪:

git remote add upstream https://github.com/denodev/typedoc.git

同步:

git checkout master
git fetch upstream -ap
git rebase upstream/master

3. 翻译

在翻译之前,你应该在 Pull Requests/Issues 页面看看其他开发者正在进行的工作,以防止重复翻译。

不推荐直接在 master 分支进行翻译。

推荐每次翻译之前新建一个功能分支,比如翻译 Deno.cwd 可以新建分支 deno-cwd:

git checkout master
git checkout -b deno-cwd
git push -u origin deno-cwd

如果你的翻译任务可以持续很长时间,你应该提一个 Merge Request。选择 Draft PR:

标题和描述里面写清楚你正在进行的工作,防止重复工作。当翻译完成后,点击 Ready for view:

4. 完成

提完 PR 后其他开发者会对你的翻译进行 review。

5. 注意

如果你是第一次参与翻译,可以查看 good first issue,我会使用这个标签来标记一些优秀的案例。

致谢

感谢所有参与翻译工作的开发者们。

@justjavac justjavac added the good first issue Good for newcomers label Apr 14, 2020
@justjavac justjavac self-assigned this Apr 14, 2020
@justjavac justjavac pinned this issue Apr 14, 2020
@justjavac justjavac reopened this Apr 14, 2020
@justjavac justjavac removed the good first issue Good for newcomers label Apr 14, 2020
@fireairforce
Copy link
Contributor

👍👍👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants