You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@rocketmq.apache.org by GitBox <gi...@apache.org> on 2022/07/07 02:39:50 UTC
[GitHub] [rocketmq-site] tsunghanjacktsai commented on a diff in pull request #151: Add Contribute Guide Document(cn) to new official website

tsunghanjacktsai commented on code in PR #151:
URL: https://github.com/apache/rocketmq-site/pull/151#discussion_r915391084


##########
docs/08-贡献指南/29how-to-contribute.md:
##########
@@ -39,12 +41,19 @@ Apache RocketMQ 社区提供完备的处理流程帮您解答问题。 您可以
 
 Apache RocketMQ 社区成员主要通过以下两种邮件沟通和交流：
 
-*  [user mailing lists](mailto:users@rocketmq.apache.org) ：Apache RocketMQ 用户 通过该邮件列表提问以寻求帮助或建议。您可以通过订阅该邮件系统以帮助他人解决问题来贡献社区。此外, 您还可以在 Stack Overflow 上检索 [rocketmq](https://stackoverflow.com/questions/tagged/rocketmq) 标签 回答用户的问题并获取更多见解。
-*  [development mailing list](mailto:dev@rocketmq.apache.org) : Apache RocketMQ 开发者 通过该邮件列表交流新特性，预发布版本，一般的开发流程等。若您热衷于为 RocketMQ 社区贡献代码，可以加入该邮件列表。
+* [user mailing lists](mailto:users@rocketmq.apache.org) ：Apache RocketMQ 用户通过该邮件列表提问以寻求帮助或建议。

Review Comment:
   user mailing lists -> User mailing list



##########
docs/08-贡献指南/29how-to-contribute.md:
##########
@@ -13,19 +13,21 @@ Apache RocketMQ —— 开放共享的开源社区，诚挚邀请您的加入
 - 测试预发布版本
 
 
-## 提出问题！
+## 请求答疑
 
-Apache RocketMQ 社区提供完备的处理流程帮您解答问题。 您可以通过 [user mailing list](https://rocketmq.apache.org/about/contact/) 和 [apache-rocketmq](https://stackoverflow.com/questions/tagged/rocketmq) 进行提问。
+Apache RocketMQ 社区提供完备的处理流程帮您解答问题。
+
+您可以通过 [user mailing lists](mailto:users@rocketmq.apache.org) 和 [stackoverflow rocketmq](https://stackoverflow.com/questions/tagged/rocketmq) 进行提问。

Review Comment:
   user mailing lists -> user mailing list
   stackoverflow rocketmq -> Stack Overflow #rocketmq



##########
docs/08-贡献指南/31pull-request.md:
##########
@@ -1 +1,183 @@
 # pull-request
+
+本文将引导您通过 Git 贡献 RocketMQ
+
+# Github 远程仓库
+
+本小节作为前置知识，简要说明使用 Git 贡献 RocketMQ 原因，有相关基础的同学可以自行跳过
+
+首先您需要自行了解 Git 和 Github 相关概念

Review Comment:
   Github -> GitHub



##########
docs/08-贡献指南/29how-to-contribute.md:
##########
@@ -39,12 +41,19 @@ Apache RocketMQ 社区提供完备的处理流程帮您解答问题。 您可以
 
 Apache RocketMQ 社区成员主要通过以下两种邮件沟通和交流：
 
-*  [user mailing lists](mailto:users@rocketmq.apache.org) ：Apache RocketMQ 用户 通过该邮件列表提问以寻求帮助或建议。您可以通过订阅该邮件系统以帮助他人解决问题来贡献社区。此外, 您还可以在 Stack Overflow 上检索 [rocketmq](https://stackoverflow.com/questions/tagged/rocketmq) 标签 回答用户的问题并获取更多见解。
-*  [development mailing list](mailto:dev@rocketmq.apache.org) : Apache RocketMQ 开发者 通过该邮件列表交流新特性，预发布版本，一般的开发流程等。若您热衷于为 RocketMQ 社区贡献代码，可以加入该邮件列表。
+* [user mailing lists](mailto:users@rocketmq.apache.org) ：Apache RocketMQ 用户通过该邮件列表提问以寻求帮助或建议。
+
+  您可以通过订阅该邮件系统以帮助他人解决问题来贡献社区；
+
+  您还可以在 Stack Overflow 上检索 [rocketmq](https://stackoverflow.com/questions/tagged/rocketmq) 标签 回答用户的问题并获取更多见解。
+
+* [development mailing list](mailto:dev@rocketmq.apache.org) : Apache RocketMQ 开发者通过该邮件列表交流新特性，预发布版本，一般的开发流程等。

Review Comment:
   development mailing list -> Development mailing list



##########
docs/08-贡献指南/31pull-request.md:
##########
@@ -1 +1,183 @@
 # pull-request
+
+本文将引导您通过 Git 贡献 RocketMQ
+
+# Github 远程仓库
+
+本小节作为前置知识，简要说明使用 Git 贡献 RocketMQ 原因，有相关基础的同学可以自行跳过
+
+首先您需要自行了解 Git 和 Github 相关概念

Review Comment:
   Github -> GitHub



##########
docs/08-贡献指南/31pull-request.md:
##########
@@ -1 +1,183 @@
 # pull-request
+
+本文将引导您通过 Git 贡献 RocketMQ
+
+# Github 远程仓库
+
+本小节作为前置知识，简要说明使用 Git 贡献 RocketMQ 原因，有相关基础的同学可以自行跳过
+
+首先您需要自行了解 Git 和 Github 相关概念
+
+思考：从开发者角度，如何与他人协作完成项目？
+
+如果您想到通过打包压缩然后复制粘贴的方式，那么请再试想一下扩大参与者的范围至 10k+ 级别
+
+这就是远程仓库的意义：开发者可以很方便地从 Github 上获取仓库代码，并提交开发分支到远程仓库与他人交流和共享
+
+![1656601484232](/picture/31pull-request/1_Github.png)
+
+那么，有了这个公共仓库，然后呢？
+
+如何下载远程仓库的代码？
+
+如何提交开发分支到远程仓库？
+
+# Git 贡献指南
+
+① fork [apache/rocketmq](https://github.com/apache/rocketmq) 仓库至个人 Github 远程仓库

Review Comment:
   Github -> GitHub



##########
docs/08-贡献指南/31pull-request.md:
##########
@@ -1 +1,183 @@
 # pull-request
+
+本文将引导您通过 Git 贡献 RocketMQ
+
+# Github 远程仓库
+
+本小节作为前置知识，简要说明使用 Git 贡献 RocketMQ 原因，有相关基础的同学可以自行跳过
+
+首先您需要自行了解 Git 和 Github 相关概念
+
+思考：从开发者角度，如何与他人协作完成项目？
+
+如果您想到通过打包压缩然后复制粘贴的方式，那么请再试想一下扩大参与者的范围至 10k+ 级别
+
+这就是远程仓库的意义：开发者可以很方便地从 Github 上获取仓库代码，并提交开发分支到远程仓库与他人交流和共享
+
+![1656601484232](/picture/31pull-request/1_Github.png)
+
+那么，有了这个公共仓库，然后呢？
+
+如何下载远程仓库的代码？
+
+如何提交开发分支到远程仓库？
+
+# Git 贡献指南
+
+① fork [apache/rocketmq](https://github.com/apache/rocketmq) 仓库至个人 Github 远程仓库
+
+```shell
+https://github.com/cuser/rocketmq.git # cuser's rocketmq repo[repository] url
+```
+
+说明：```cuser``` GitHub用户名，```Fork``` 后可通过个人主页 Repositories ，找到复刻仓库并查看地址
+
+② 自行安装 Git 并克隆到本地仓库
+
+```shell
+git clone https://github.com/cuser/rocketmq.git # git clone [repo url]
+```
+
+说明：克隆到的本地仓库会以 GitHub 仓库作为远程仓库，并以```origin```命名远程仓库
+
+③ 获取开发分支最新代码
+
+```shell
+git rebase origin/develop # git rebase [branch]
+```
+
+说明： [rebase <branch>](https://git-scm.com/docs/git-rebase) 基本说法是换基，可通过链接示例了解该步的必要性
+
+④ 在本地仓库执行更改
+
+```shell
+git checkout -b RocketMQ-Vxx.0 # git checkout [-b] [new-branch]
+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``` 同级目录
+
+⑤ 推送更改到远程仓库
+
+```shell
+git push --set-upstream apache RocketMQ-Vxx.0	# push branch to https://github.com/cuser/rocketmq-site.git
+```
+
+# Github 提交 PR
+
+如下：以提交 PR 至 ```new-official-website``` 分支为例说明 PR 流程
+
+参照```Git 贡献指南```在本地仓库修改完毕，并将该分支推送到 Github 远程仓库
+
+```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
+
+② 创建合并请求，点击 Contribute 下的 Open pull request
+
+③ compare across forks 选择请求分支和开发分支
+
+![1656580236831](/picture/31pull-request/2_compare.png)
+
+base repository / base : 请求仓库及请求分支
+
+head repository / compare : 开发仓库及开发分支
+
+注意请务必正确选择请求分支与开发分支，并请在得到分支所有者许可后再请求合入
+
+④ 填写首字母大写的 PR 摘要，并在 Write 标签下简要描述 PR 内容
+
+![1656589498318](/picture/31pull-request/3_Write.png)
+
+	提交 PR 前，请先做如下确认：
+
+1. 已创建与 PR 对应的 [Github issue]( [apache/rocketmq: Mirror of Apache RocketMQ (github.com)](https://github.com/apache/rocketmq/issues) )

Review Comment:
   Github -> GitHub



##########
docs/08-贡献指南/29how-to-contribute.md:
##########
@@ -88,13 +98,13 @@ Apache RocketMQ 官网代表着 Apache RocketMQ 和 Apache RocketMQ 社区。其
 
 社区接纳任何有助于优化网站的贡献。
 
-请通过创建 [Github issue](https://github.com/apache/rocketmq-site/issues) 提供您关于网站的建议和创意
+请通过创建 [Github issue](https://github.com/apache/rocketmq-site/issues) 提供您关于网站的建议和创意。

Review Comment:
   Github issue -> GitHub Issue



##########
docs/08-贡献指南/31pull-request.md:
##########
@@ -1 +1,183 @@
 # pull-request
+
+本文将引导您通过 Git 贡献 RocketMQ
+
+# Github 远程仓库
+
+本小节作为前置知识，简要说明使用 Git 贡献 RocketMQ 原因，有相关基础的同学可以自行跳过
+
+首先您需要自行了解 Git 和 Github 相关概念
+
+思考：从开发者角度，如何与他人协作完成项目？
+
+如果您想到通过打包压缩然后复制粘贴的方式，那么请再试想一下扩大参与者的范围至 10k+ 级别
+
+这就是远程仓库的意义：开发者可以很方便地从 Github 上获取仓库代码，并提交开发分支到远程仓库与他人交流和共享

Review Comment:
   Github -> GitHub



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@rocketmq.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org