[GitHub] [rocketmq-site] RongtongJin commented on a diff in pull request #145: Add pull request document for new official website

[GitBox <gi...@apache.org>]

RongtongJin commented on code in PR #145:
URL: https://github.com/apache/rocketmq-site/pull/145#discussion_r912481152


##########
docs/31pull-request.md:
##########
@@ -1 +1,216 @@
 # pull-request
+
+本文将引导您通过 Git 贡献 RocketMQ
+
+# Github 远程仓库
+
+本小节作为前置知识，简要说明使用 Git 贡献 RocketMQ 原因，有相关基础的同学可以自行跳过
+
+首先您需要自行了解 Git 和 Github 相关概念
+
+思考：从开发者角度，如何与他人协作完成项目？
+
+如果您想到通过打包压缩然后复制粘贴的方式，那么请再试想一下扩大参与者的范围至 10k+ 级别
+
+这就是远程仓库的意义：开发者可以很方便地从 Github 上获取仓库代码，并提交开发分支到远程仓库与他人交流和共享
+
+![1656601484232](picture/31pull-request/1_Github.png)
+
+那么，有了这个公共仓库，然后呢？
+
+如何下载远程仓库的代码？
+
+如何提交开发分支到远程仓库？
+
+如何使开发分支相互可见？
+
+薅头发的请先住手，Linus 大神已经提供了解决方案 Git
+
+# Git 贡献指南
+
+① 复刻 [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 remote add apache https://github.com/cuser/rocketmq.git	# git remote add [repo name] [repo url]
+```
+
+说明：可以使用 git remote add 指定远程仓库并命名，若跳过该步，后续流程请使用```origin```作为仓库名
+
+④ 拉取远程仓库开发分支
+
+```shell
+git fetch apache develop # git fetch [repo name] [repo branch]
+```
+
+说明：develop 为默认开发分支，可在 GitHub 仓库主页 ```branches``` 标签处了解详情

Review Comment:
   这里的流程有些问题，因为添加的apache上游其实和origin是一样的，所以3和4步感觉不是很必要，那干脆删掉3和4的步骤，直接用origin就行。



##########
docs/31pull-request.md:
##########
@@ -1 +1,216 @@
 # pull-request
+
+本文将引导您通过 Git 贡献 RocketMQ
+
+# Github 远程仓库
+
+本小节作为前置知识，简要说明使用 Git 贡献 RocketMQ 原因，有相关基础的同学可以自行跳过
+
+首先您需要自行了解 Git 和 Github 相关概念
+
+思考：从开发者角度，如何与他人协作完成项目？
+
+如果您想到通过打包压缩然后复制粘贴的方式，那么请再试想一下扩大参与者的范围至 10k+ 级别
+
+这就是远程仓库的意义：开发者可以很方便地从 Github 上获取仓库代码，并提交开发分支到远程仓库与他人交流和共享
+
+![1656601484232](picture/31pull-request/1_Github.png)
+
+那么，有了这个公共仓库，然后呢？
+
+如何下载远程仓库的代码？
+
+如何提交开发分支到远程仓库？
+
+如何使开发分支相互可见？
+
+薅头发的请先住手，Linus 大神已经提供了解决方案 Git
+
+# Git 贡献指南
+
+① 复刻 [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 remote add apache https://github.com/cuser/rocketmq.git	# git remote add [repo name] [repo url]
+```
+
+说明：可以使用 git remote add 指定远程仓库并命名，若跳过该步，后续流程请使用```origin```作为仓库名
+
+④ 拉取远程仓库开发分支
+
+```shell
+git fetch apache develop # git fetch [repo name] [repo branch]
+```
+
+说明：develop 为默认开发分支，可在 GitHub 仓库主页 ```branches``` 标签处了解详情
+
+⑤ 获取开发分支最新代码
+
+```shell
+git rebase apache/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
+```
+
+说明：若未创建远程仓库，替换 ```apache``` 为 ``` origin```
+
+# 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
+
+![1656576449012](picture/31pull-request/2_switch branch.png)
+
+② 创建合并请求，点击 Contribute 下的 Open pull request
+
+![1656576385381](picture/31pull-request/3_OpenPR.png)
+
+③ compare across forks 选择请求分支和开发分支
+
+![1656580236831](picture/31pull-request/4_compare.png)
+
+base repository / base : 请求仓库及请求分支
+
+head repository / compare : 开发仓库及开发分支
+
+注意请务必正确选择请求分支与开发分支，并请在得到分支所有者许可后再请求合入
+
+④ 填写首字母大写的 PR 摘要，并在 Write 标签下简要描述 PR 内容
+
+![1656589498318](picture/31pull-request/5_Write.png)
+
+​	提交 PR 前，请先做如下确认：
+
+1. 已创建与 PR 对应的 [Github issue]( [apache/rocketmq: Mirror of Apache RocketMQ (github.com)](https://github.com/apache/rocketmq/issues) )
+2. 修改内容符合 [Coding Guidelines](/docs/30code-guidelines) 编程规范
+3. pull request 摘要以 [ISSUE #XXX] 开始并简要描述变更需求
+4. 概述 PR 变更需求，变更日志，验证信息，可参考 [demo pull request](https://github.com/apache/rocketmq/pull/152) 
+5. 提交内容具备完整的测试用例，并确保基本检查，单元测试，集成测试通过
+6. 若贡献值较高，请提交 [Apache个人贡献者许可协议](http://www.apache.org/licenses/#clas) 

Review Comment:
   第6条没太看懂，可以先删除



##########
docs/30code-guidelines.md:
##########
@@ -1 +1,38 @@
 # code-guidelines
+
+# 前言
+
+本文向您介绍编写软件源码的规范和指南。
+
+研究表明研发代码的 80% 时间用于软件维护，包括软件源码解读，源码重构，源码维护
+
+制定并强制推行编码规则和编码指南，有助于提高代码的可读性，强化团队代码的所有权，
+
+帮助工程师快速且深入理解新增代码，简化维护的

Review Comment:
   “强化团队代码的所有权”可以删除，“帮助工程师快速且深入理解新增代码，简化维护的”这句话不完整。或者上面两句话可以合成一句话



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

Review Comment:
   这句话比较口语化，可以删除



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

Review Comment:
   复刻直接改成 fork吧，开发人员应该是可以理解的



-- 
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