You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by di...@apache.org on 2022/11/11 01:30:04 UTC
[rocketmq-site] branch new-official-website updated: [ISSUE #298] Add Translation for "Github提交PR" Section in the v4.x & 5.0 Document (CN -> EN) (#333)
This is an automated email from the ASF dual-hosted git repository.
dinglei pushed a commit to branch new-official-website
in repository https://gitbox.apache.org/repos/asf/rocketmq-site.git
The following commit(s) were added to refs/heads/new-official-website by this push:
new fc579351a [ISSUE #298] Add Translation for "Github提交PR" Section in the v4.x & 5.0 Document (CN -> EN) (#333)
fc579351a is described below
commit fc579351a042ceb7f7696bf4d6abc1ed81242253
Author: Oliver <wq...@163.com>
AuthorDate: Fri Nov 11 09:29:59 2022 +0800
[ISSUE #298] Add Translation for "Github提交PR" Section in the v4.x & 5.0 Document (CN -> EN) (#333)
---
.../current/08-contributionGuide/31pull-request.md | 124 ++++++++++-----------
.../07-contributionGuide/31pull-request.md | 121 ++++++++++----------
2 files changed, 115 insertions(+), 130 deletions(-)
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/08-contributionGuide/31pull-request.md b/i18n/en/docusaurus-plugin-content-docs/current/08-contributionGuide/31pull-request.md
index 4dde73a85..417bec421 100644
--- a/i18n/en/docusaurus-plugin-content-docs/current/08-contributionGuide/31pull-request.md
+++ b/i18n/en/docusaurus-plugin-content-docs/current/08-contributionGuide/31pull-request.md
@@ -1,54 +1,54 @@
-# Github提交PR
+# GitHub Submit PR
-本文将引导您通过 Git 贡献 RocketMQ
+This article walks you through contributing RocketMQ through Git
-## Github 远程仓库
+## GitHub Remote Repository
-本小节作为前置知识，简要说明使用 Git 贡献 RocketMQ 原因，有相关基础的同学可以自行跳过
+As a prerequisite, this section briefly explains the reasons for using Git to contribute RocketMQ. If you have related knowledge, you can skip it
-首先您需要自行了解 Git 和 GitHub 相关概念
+First, you need to educate yourself about Git and GitHub
-思考：从开发者角度，如何与他人协作完成项目？
+Think: From a developer's perspective, how do you collaborate with others to complete a project?
-如果您想到通过打包压缩然后复制粘贴的方式，那么请再试想一下扩大参与者的范围至 10k+ 级别
+If you think of packaging, compression, and then copy and paste, think of expanding the scope of participants to the 10k+ level
-这就是远程仓库的意义：开发者可以很方便地从 GitHub 上获取仓库代码，并提交开发分支到远程仓库与他人交流和共享
+This is the point of the remote repository: Developers can easily access the repository code from GitHub and submit development branches to the remote repository to communicate and share with others
-那么，有了这个公共仓库，然后呢？
+So, with this public repository, what then?
-如何下载远程仓库的代码？
+How do I download the code for a remote repository?
-如何提交开发分支到远程仓库？
+How do I commit a development branch to a remote repository?
-## Git 贡献指南
+## Git Contribution Guide
-① fork [apache/rocketmq](https://github.com/apache/rocketmq) 仓库至个人 GitHub 远程仓库
+① fork [apache/rocketmq](https://github.com/apache/rocketmq) to personal GitHub remote repository
```shell
https://github.com/cuser/rocketmq.git # cuser's rocketmq repo[repository] url
```
-说明：```cuser``` GitHub用户名，```Fork``` 后可通过个人主页 Repositories ，找到复刻仓库并查看地址
+Notice: ```cuser``` GitHub username，after ```Fork``` you can find the copy repository through the personal home page Repositories, and view the address
-② 自行安装 Git 并克隆到本地仓库
+② Install Git yourself and clone it to your local repository
```shell
git clone https://github.com/cuser/rocketmq.git # git clone [repo url]
```
-说明：克隆到的本地仓库会以 GitHub 仓库作为远程仓库，并以```origin```命名远程仓库
+Notice：The cloned local repository will use GitHub repository as the remote repository, and will be named ```origin```
-③ 获取开发分支最新代码
+③ Get the latest code for the development branch
```shell
git rebase origin/develop # git rebase [branch]
```
-说明： [rebase` <branch>`](https://git-scm.com/docs/git-rebase) 基本说法是换基，可通过链接示例了解该步的必要性
+Notice： [rebase` <branch>`](https://git-scm.com/docs/git-rebase) The basic term is base swapping, and you can see why this step is necessary by looking at the linked examples
-④ 在本地仓库执行更改
+④ Make changes in the local repository
```shell
git checkout -b RocketMQ-Vxx.0 # git checkout [-b] [new-branch]
@@ -56,62 +56,62 @@ git add /rocketmq/pom.xml # git add [dir/file]
git commit -a -m "pom" # git commit [-all] [-msg] [message]
```
-说明： 参考[Git](https://git-scm.com/docs/git-add)了解详情，使用相对路径请切换至 ```.git``` 同级目录
+Notice： Reference [Git](https://git-scm.com/docs/git-add)，Use relative paths to switch to the same directory as ```.git```
-⑤ 推送更改到远程仓库
+⑤ Push changes to the remote repository
```shell
git push --set-upstream apache RocketMQ-Vxx.0 # push branch to https://github.com/cuser/rocketmq-site.git
```
-## Github 提交 PR
+## GitHub Commit PR
-如下：以提交 PR 至 ```new-official-website``` 分支为例说明 PR 流程
+As follows: Take submitting PR to the ```new-official-website``` branch as an example to illustrate the PR process
-参照```Git 贡献指南```在本地仓库修改完毕，并将该分支推送到 Github 远程仓库
+Reference ```Git Contribution Guide```Modify the branch in the local repository and push it to the GitHub remote repository
```shell
git checkout new-official-website # git checkout -b new-official-website
git push origin new-official-website # push to https://github.com/cuser/rocketmq-site.git
```
-① Github 远程仓库切换至开发分支 new-official-website
+① Switch the GitHub remote repository to the development branch new-official-website
-② 创建合并请求，点击 Contribute 下的 Open pull request
+② Create the pull request and click the open pull request under Contribute
-③ compare across forks 选择请求分支和开发分支
+③ compare across forks, Select the request branch and the development branch
-base repository / base : 请求仓库及请求分支
+base repository / base : Request repository and request branch
-head repository / compare : 开发仓库及开发分支
+head repository / compare : Develop repository and branch
-注意请务必正确选择请求分支与开发分支，并请在得到分支所有者许可后再请求合入
+Be sure to correctly select the request branch and the development branch, and request merging only after obtaining permission from the branch owner
-④ 填写首字母大写的 PR 摘要，并在 Write 标签下简要描述 PR 内容
+④ Fill in the PR summary with uppercase letters and briefly describe the PR content
- 提交 PR 前，请先做如下确认：
+ Before submitting PR, please confirm as follows:
-1. 已创建与 PR 对应的 [GitHub Issue]( [apache/rocketmq: Mirror of Apache RocketMQ (github.com)](https://github.com/apache/rocketmq/issues) )
-2. 修改内容符合 [Coding Guidelines](/docs/contributionGuide/30code-guidelines) 编程规范
-3. PR 摘要以 [ISSUE #XXX] 开始并简要描述变更需求
-4. 概述 PR 变更需求，变更日志，验证信息，可参考 [PR Demo](https://github.com/apache/rocketmq/pull/152)
-5. 提交内容具备完整的测试用例，并确保基本检查，单元测试，集成测试通过
+1. A [GitHub Issue]( [apache/rocketmq: Mirror of Apache RocketMQ (github.com)](https://github.com/apache/rocketmq/issues) ) corresponding to PR has been created
+2. Modified content to comply with [Coding Guidelines](/docs/contributionGuide/30code-guidelines) programming specification
+3. The PR summary begins with [ISSUE #XXX] and briefly describes the change requirements
+4. Outline PR change requirements, change logs, and validation information,Reference [PR Demo](https://github.com/apache/rocketmq/pull/152)
+5. Submit content with complete test cases and ensure that basic checks, unit tests, and integration tests pass
-⑤ 点击 "Create pull request" ，请求合并该分支
+⑤ Click "Create pull request" , Request that the branch be merged
-⑥ 至此，PR 已经在 apache/rocketmq-site 远程仓库上可见，所有协作者都可以 Review 该PR 并提供建议
+⑥ At this point, the PR is visible on the apache/rocketmq-site remote repository, and all collaborators can review the PR and make suggestions
-您可以根据评论在本地完成修改并进行多次提交。请求合并和提交修改的相关信息会同步展示在 PR 页面、issue 列表、RocketMQ 的邮件列表中，以便提醒 committer 及时审核 PR
+You can make changes locally and commit multiple times based on comments. Information about the request to merge and the submission of changes is displayed simultaneously on the PR page, the issue list, and the RocketMQ mailing list, in order to remind the committer to review the PR in a timely manner
-## 合并 PR
+## Merge PR
-开源项目开发分支合并由 committer 完成。
+Open source Project development branch mergers are performed by the committer.
-① 合并 contributor PR
+① Merge contributor PR
```shell
git checkout develop # switch to local develop branch
@@ -119,15 +119,15 @@ git pull apache develop # fast-forward to current remote HEAD
git pull --squash https://github.com/cuser/rocketmq.git RocketMQ-Vxx.0 # merge to branch
```
-拉取的请求合并分支可能包含多次提交，建议使用 ```--squash``` 指令压缩为一次 commit
+A pull request merge branch may contain multiple commits. It is recommended that the ```--squash``` directive compress the commit to a single commit
-合并前务必要解决合并冲突，并确保当前分支同步于远程分支
+It is important to resolve merge conflicts and ensure that the current branch is synchronized to the remote branch before merging
+
+Please read[Git pull]( [Git - git-pull Documentation (git-scm.com)](https://git-scm.com/docs/git-pull) ) to learn fast-forward and other info
-请阅读 [Git pull]( [Git - git-pull Documentation (git-scm.com)](https://git-scm.com/docs/git-pull) ) 了解 fast-forward 等相关详情
+② Merge committer PR
-② 合并 committer PR
-
-若 committer 合并自己的 PR , 使用 [Git merge]( [Git - git-merge Documentation (git-scm.com)](https://git-scm.com/docs/git-merge) ) 即可
+If committer merges its own PR, run the command [Git merge]( [Git - git-merge Documentation (git-scm.com)](https://git-scm.com/docs/git-merge) )
```shell
git checkout develop # switch to local develop branch
@@ -135,47 +135,39 @@ git pull apache develop # fast-forward to current remote HEAD
git merge --squash RocketMQ-Vxx.0 # merge to branch
```
-③ 进行常规的补丁检查，使用内置的测试用例构建项目，并请务必修改 changelog
+③ Do regular patch checks, build projects with built-in test cases, and be sure to modify the changelog
-④ 若上述工作均已完成，可以执行下面的指令提交合并，回馈开发者分支状态，并关闭 PR
+④ Once all of the above is done, submit the merge with the following instructions, feedback the branch status to the developer, and close PR
```shell
git commit --author="contributor_name <contributor_email>" -a -m "RocketMQ-Vxx.0 description closes apache/rocketmq#ZZ"
```
-关闭 PR 的详情，请参考 [Close PR](https://docs.github.com/cn/issues/tracking-your-work-with-issues/closing-an-issue)
+For details of closing PR, reference [Close PR](https://docs.github.com/cn/issues/tracking-your-work-with-issues/closing-an-issue)
-⑤ 将合并后的分支推送到 apache/rocketmq 远程仓库
+⑤ Push the merged branch to the apache/rocketmq remote repository
```shell
git push apache develop
```
-⑥ PR 被提交后，会保留到 GitHub 远程仓库，也可以同步更新个人 GitHub 仓库
+⑥ Once a PR is submitted, it will remain in the GitHub remote repository, and you can also update your personal GitHub repository simultaneously
```shell
git push origin develop
```
-关于合并修改的建议：squash 会丢弃开发分支的 commit 信息
+Notice: squash discards the commit information of the development branch
-## 拒绝 PR
+## Reject PR
-拒绝 PR ：意味着并不执行 pull 或 merge，而仅仅提交拒绝 PR 信息
+Reject PR: Means that no pull or merge is performed, but only the reject PR message is submitted
```SHELL
git commit --allow-empty -m "RocketMQ-Vxx.0 closes apache/rocketmq#ZZ *Won't fix*"
git push apache develop
```
-关闭 Github 上编号 #ZZ 的 PR
-
-
-
-
-
-
-
-
+Close PR #ZZ on GitHub
diff --git a/i18n/en/docusaurus-plugin-content-docs/version-5.0/07-contributionGuide/31pull-request.md b/i18n/en/docusaurus-plugin-content-docs/version-5.0/07-contributionGuide/31pull-request.md
index 4dde73a85..269a1fcc0 100644
--- a/i18n/en/docusaurus-plugin-content-docs/version-5.0/07-contributionGuide/31pull-request.md
+++ b/i18n/en/docusaurus-plugin-content-docs/version-5.0/07-contributionGuide/31pull-request.md
@@ -1,54 +1,54 @@
-# Github提交PR
+# GitHub Submit PR
-本文将引导您通过 Git 贡献 RocketMQ
+This article walks you through contributing RocketMQ through Git
-## Github 远程仓库
+## GitHub Remote Repository
-本小节作为前置知识，简要说明使用 Git 贡献 RocketMQ 原因，有相关基础的同学可以自行跳过
+As a prerequisite, this section briefly explains the reasons for using Git to contribute RocketMQ. If you have related knowledge, you can skip it
-首先您需要自行了解 Git 和 GitHub 相关概念
+First, you need to educate yourself about Git and GitHub
-思考：从开发者角度，如何与他人协作完成项目？
+Think: From a developer's perspective, how do you collaborate with others to complete a project?
-如果您想到通过打包压缩然后复制粘贴的方式，那么请再试想一下扩大参与者的范围至 10k+ 级别
+If you think of packaging, compression, and then copy and paste, think of expanding the scope of participants to the 10k+ level
-这就是远程仓库的意义：开发者可以很方便地从 GitHub 上获取仓库代码，并提交开发分支到远程仓库与他人交流和共享
+This is the point of the remote repository: Developers can easily access the repository code from GitHub and submit development branches to the remote repository to communicate and share with others
-那么，有了这个公共仓库，然后呢？
+So, with this public repository, what then?
-如何下载远程仓库的代码？
+How do I download the code for a remote repository?
-如何提交开发分支到远程仓库？
+How do I commit a development branch to a remote repository?
-## Git 贡献指南
+## Git Contribution Guide
-① fork [apache/rocketmq](https://github.com/apache/rocketmq) 仓库至个人 GitHub 远程仓库
+① fork [apache/rocketmq](https://github.com/apache/rocketmq) to personal GitHub remote repository
```shell
https://github.com/cuser/rocketmq.git # cuser's rocketmq repo[repository] url
```
-说明：```cuser``` GitHub用户名，```Fork``` 后可通过个人主页 Repositories ，找到复刻仓库并查看地址
+Notice: ```cuser``` GitHub username，after ```Fork``` you can find the copy repository through the personal home page Repositories, and view the address
-② 自行安装 Git 并克隆到本地仓库
+② Install Git yourself and clone it to your local repository
```shell
git clone https://github.com/cuser/rocketmq.git # git clone [repo url]
```
-说明：克隆到的本地仓库会以 GitHub 仓库作为远程仓库，并以```origin```命名远程仓库
+Notice：The cloned local repository will use GitHub repository as the remote repository, and will be named ```origin```
-③ 获取开发分支最新代码
+③ Get the latest code for the development branch
```shell
git rebase origin/develop # git rebase [branch]
```
-说明： [rebase` <branch>`](https://git-scm.com/docs/git-rebase) 基本说法是换基，可通过链接示例了解该步的必要性
+Notice： [rebase` <branch>`](https://git-scm.com/docs/git-rebase) The basic term is base swapping, and you can see why this step is necessary by looking at the linked examples
-④ 在本地仓库执行更改
+④ Make changes in the local repository
```shell
git checkout -b RocketMQ-Vxx.0 # git checkout [-b] [new-branch]
@@ -56,62 +56,62 @@ git add /rocketmq/pom.xml # git add [dir/file]
git commit -a -m "pom" # git commit [-all] [-msg] [message]
```
-说明： 参考[Git](https://git-scm.com/docs/git-add)了解详情，使用相对路径请切换至 ```.git``` 同级目录
+Notice： Reference [Git](https://git-scm.com/docs/git-add)，Use relative paths to switch to the same directory as ```.git```
-⑤ 推送更改到远程仓库
+⑤ Push changes to the remote repository
```shell
git push --set-upstream apache RocketMQ-Vxx.0 # push branch to https://github.com/cuser/rocketmq-site.git
```
-## Github 提交 PR
+## GitHub Commit PR
-如下：以提交 PR 至 ```new-official-website``` 分支为例说明 PR 流程
+As follows: Take submitting PR to the ```new-official-website``` branch as an example to illustrate the PR process
-参照```Git 贡献指南```在本地仓库修改完毕，并将该分支推送到 Github 远程仓库
+Reference ```Git Contribution Guide```Modify the branch in the local repository and push it to the GitHub remote repository
```shell
git checkout new-official-website # git checkout -b new-official-website
git push origin new-official-website # push to https://github.com/cuser/rocketmq-site.git
```
-① Github 远程仓库切换至开发分支 new-official-website
+① Switch the GitHub remote repository to the development branch new-official-website
-② 创建合并请求，点击 Contribute 下的 Open pull request
+② Create the pull request and click the open pull request under Contribute
-③ compare across forks 选择请求分支和开发分支
+③ compare across forks, Select the request branch and the development branch
-base repository / base : 请求仓库及请求分支
+base repository / base : Request repository and request branch
-head repository / compare : 开发仓库及开发分支
+head repository / compare : Develop repository and branch
-注意请务必正确选择请求分支与开发分支，并请在得到分支所有者许可后再请求合入
+Be sure to correctly select the request branch and the development branch, and request merging only after obtaining permission from the branch owner
-④ 填写首字母大写的 PR 摘要，并在 Write 标签下简要描述 PR 内容
+④ Fill in the PR summary with uppercase letters and briefly describe the PR content
- 提交 PR 前，请先做如下确认：
+ Before submitting PR, please confirm as follows:
-1. 已创建与 PR 对应的 [GitHub Issue]( [apache/rocketmq: Mirror of Apache RocketMQ (github.com)](https://github.com/apache/rocketmq/issues) )
-2. 修改内容符合 [Coding Guidelines](/docs/contributionGuide/30code-guidelines) 编程规范
-3. PR 摘要以 [ISSUE #XXX] 开始并简要描述变更需求
-4. 概述 PR 变更需求，变更日志，验证信息，可参考 [PR Demo](https://github.com/apache/rocketmq/pull/152)
-5. 提交内容具备完整的测试用例，并确保基本检查，单元测试，集成测试通过
+1. A [GitHub Issue]( [apache/rocketmq: Mirror of Apache RocketMQ (github.com)](https://github.com/apache/rocketmq/issues) ) corresponding to PR has been created
+2. Modified content to comply with [Coding Guidelines](/docs/contributionGuide/30code-guidelines) programming specification
+3. The PR summary begins with [ISSUE #XXX] and briefly describes the change requirements
+4. Outline PR change requirements, change logs, and validation information,Reference [PR Demo](https://github.com/apache/rocketmq/pull/152)
+5. Submit content with complete test cases and ensure that basic checks, unit tests, and integration tests pass
-⑤ 点击 "Create pull request" ，请求合并该分支
+⑤ Click "Create pull request" , Request that the branch be merged
-⑥ 至此，PR 已经在 apache/rocketmq-site 远程仓库上可见，所有协作者都可以 Review 该PR 并提供建议
+⑥ At this point, the PR is visible on the apache/rocketmq-site remote repository, and all collaborators can review the PR and make suggestions
-您可以根据评论在本地完成修改并进行多次提交。请求合并和提交修改的相关信息会同步展示在 PR 页面、issue 列表、RocketMQ 的邮件列表中，以便提醒 committer 及时审核 PR
+You can make changes locally and commit multiple times based on comments. Information about the request to merge and the submission of changes is displayed simultaneously on the PR page, the issue list, and the RocketMQ mailing list, in order to remind the committer to review the PR in a timely manner
-## 合并 PR
+## Merge PR
-开源项目开发分支合并由 committer 完成。
+Open source Project development branch mergers are performed by the committer.
-① 合并 contributor PR
+① Merge contributor PR
```shell
git checkout develop # switch to local develop branch
@@ -119,15 +119,15 @@ git pull apache develop # fast-forward to current remote HEAD
git pull --squash https://github.com/cuser/rocketmq.git RocketMQ-Vxx.0 # merge to branch
```
-拉取的请求合并分支可能包含多次提交，建议使用 ```--squash``` 指令压缩为一次 commit
+A pull request merge branch may contain multiple commits. It is recommended that the ```--squash``` directive compress the commit to a single commit
-合并前务必要解决合并冲突，并确保当前分支同步于远程分支
+It is important to resolve merge conflicts and ensure that the current branch is synchronized to the remote branch before merging
-请阅读 [Git pull]( [Git - git-pull Documentation (git-scm.com)](https://git-scm.com/docs/git-pull) ) 了解 fast-forward 等相关详情
+Please read[Git pull]( [Git - git-pull Documentation (git-scm.com)](https://git-scm.com/docs/git-pull) ) to learn fast-forward and other info
-② 合并 committer PR
+② Merge committer PR
-若 committer 合并自己的 PR , 使用 [Git merge]( [Git - git-merge Documentation (git-scm.com)](https://git-scm.com/docs/git-merge) ) 即可
+If committer merges its own PR, run the command [Git merge]( [Git - git-merge Documentation (git-scm.com)](https://git-scm.com/docs/git-merge) )
```shell
git checkout develop # switch to local develop branch
@@ -135,47 +135,40 @@ git pull apache develop # fast-forward to current remote HEAD
git merge --squash RocketMQ-Vxx.0 # merge to branch
```
-③ 进行常规的补丁检查，使用内置的测试用例构建项目，并请务必修改 changelog
+③ Do regular patch checks, build projects with built-in test cases, and be sure to modify the changelog
-④ 若上述工作均已完成，可以执行下面的指令提交合并，回馈开发者分支状态，并关闭 PR
+④ Once all of the above is done, submit the merge with the following instructions, feedback the branch status to the developer, and close PR
```shell
git commit --author="contributor_name <contributor_email>" -a -m "RocketMQ-Vxx.0 description closes apache/rocketmq#ZZ"
```
-关闭 PR 的详情，请参考 [Close PR](https://docs.github.com/cn/issues/tracking-your-work-with-issues/closing-an-issue)
+For details of closing PR, reference [Close PR](https://docs.github.com/cn/issues/tracking-your-work-with-issues/closing-an-issue)
-⑤ 将合并后的分支推送到 apache/rocketmq 远程仓库
+⑤ Push the merged branch to the apache/rocketmq remote repository
```shell
git push apache develop
```
-⑥ PR 被提交后，会保留到 GitHub 远程仓库，也可以同步更新个人 GitHub 仓库
+⑥ Once a PR is submitted, it will remain in the GitHub remote repository, and you can also update your personal GitHub repository simultaneously
```shell
git push origin develop
```
-关于合并修改的建议：squash 会丢弃开发分支的 commit 信息
+Notice: squash discards the commit information of the development branch
-## 拒绝 PR
+## Reject PR
-拒绝 PR ：意味着并不执行 pull 或 merge，而仅仅提交拒绝 PR 信息
+Reject PR: Means that no pull or merge is performed, but only the reject PR message is submitted
```SHELL
git commit --allow-empty -m "RocketMQ-Vxx.0 closes apache/rocketmq#ZZ *Won't fix*"
git push apache develop
```
-关闭 Github 上编号 #ZZ 的 PR
-
-
-
-
-
-
-
+Close PR #ZZ on GitHub