Add pull request document for new official website #145

liyijuan · 2022-07-01T09:01:41Z

Please do not create a Pull Request without creating an issue first.

What is the purpose of the change

translate en pull request document to cn and reorganized the order

Brief changelog

① basic knowledge for Github

② merge PR(committer) and PR(contributor)

Verifying this change

Normal display of pictures

Follow this checklist to help us incorporate your contribution quickly and easily:

Make sure there is a Github issue filed for the change (usually before you start working on it). Trivial changes like typos do not require a Github issue. Your pull request should address just this issue, without pulling in other changes - one PR resolves one issue.
Format the pull request title like [ISSUE #123] Fix UnknownException when host config not exist. Each commit in the pull request should have a meaningful subject line and body.
Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
Write necessary unit-test to verify your logic correction, more mock a little better when cross module dependency exist. If the new feature or significant change is committed, please remember to add integration-test in test module.
Run mvn -B clean apache-rat:check findbugs:findbugs checkstyle:checkstyle to make sure basic checks pass. Run mvn clean install -DskipITs to make sure unit-test pass. Run mvn clean test-compile failsafe:integration-test to make sure integration-test pass.
If this contribution is large, please file an Apache Individual Contributor License Agreement.

new file: docs/picture/31pull-request/1_Github.png new file: docs/picture/31pull-request/2_switch branch.png new file: docs/picture/31pull-request/3_open pull request.png new file: docs/picture/31pull-request/4_compare.png new file: docs/picture/31pull-request/5_Write.png new file: docs/picture/31pull-request/6_Create pull request.png new file: docs/picture/31pull-request/7_mail list.png

renamed: docs/picture/31pull-request/3_open pull request.png -> docs/picture/31pull-request/3_OpenPR.png renamed: docs/picture/31pull-request/6_Create pull request.png -> docs/picture/31pull-request/6_CreatePR.png renamed: docs/picture/31pull-request/7_mail list.png -> docs/picture/31pull-request/7_mailList.png

RongtongJin · 2022-07-03T12:31:43Z

docs/30code-guidelines.md

+制定并强制推行编码规则和编码指南，有助于提高代码的可读性，强化团队代码的所有权，
+
+帮助工程师快速且深入理解新增代码，简化维护的


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

RongtongJin · 2022-07-03T12:32:41Z

docs/31pull-request.md

+
+如何使开发分支相互可见？
+
+薅头发的请先住手，Linus 大神已经提供了解决方案 Git


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

RongtongJin · 2022-07-03T12:33:25Z

docs/31pull-request.md

+
+# Git 贡献指南
+
+① 复刻 [apache/rocketmq](https://github.com/apache/rocketmq) 仓库至个人 Github 远程仓库


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

RongtongJin · 2022-07-03T12:39:37Z

docs/31pull-request.md

+③ 添加并命名远程仓库
+
+```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``` 标签处了解详情


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

RongtongJin · 2022-07-03T12:40:39Z

docs/31pull-request.md

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


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

tsunghanjacktsai

您好好，

非常感谢您的贡献。除了个别提到的问题，还有以下涉及多项错误的问题麻烦你做一下改正：

Github或github应该使用官方名称GitHub，并且在文档中保持一致。
issue 改为 Issue，并且在文档中保持一致。
pull request 改为 PR 或 Pull Request，并且在文档中保持一致。
部分链接为无效链接，后面新版网站上线后请记得更新（e.g. 加上网站前缀）。
中文词语间的无效空格，比如“用户通过该邮件列表”、“xxx标签回答用户的问题”、“支持访问者下载”、“导访问者参与”等，可能要麻烦你再仔细阅读一遍文档，纠正这种错误。
有些句子最后没有加句号，请仔细检查并添加。

tsunghanjacktsai · 2022-07-04T01:59:44Z

docs/29how-to-contribute.md

+- 测试预发布版本
+
+
+## 提出问题！


标题结尾感叹号可删除，与其他标题保持一致。

该部分所使用的"问题"，用词可改为“疑惑”（question）。用于区分文档后面所提到的“问题”（bug）。

tsunghanjacktsai · 2022-07-04T02:07:08Z

docs/29how-to-contribute.md

+
+## 提出问题！
+
+Apache RocketMQ 社区提供完备的处理流程帮您解答问题。 您可以通过 [user mailing list](https://rocketmq.apache.org/about/contact/) 和 [apache-rocketmq](https://stackoverflow.com/questions/tagged/rocketmq) 进行提问。


user mailing list的链接改为“mailto:[email protected]”。

Stack Overflow的链接名应从“apache-rocketmq”改为"Stack Overflow"，避免读者不知这是Stack Overflow的链接。

tsunghanjacktsai · 2022-07-04T02:27:31Z

docs/29how-to-contribute.md

+
+社区在持续寻找反馈意见以改善 Apache RocketMQ ，您的改进方案或新特性的需求将惠及所有 RocketMQ 用户, 请在 github 上创建 [Github Issue](https://github.com/apache/rocketmq/issues)。
+
+提案需要包含适当的细节描述和影响范围，如果可能的话详述其需求。我们希望得到尽可能完备的信息，原因如下：


提案需要包含适当的细节描述和影响范围，如果可能的话详述其需求。我们希望得到尽可能完备的信息，原因如下：

可改为以下语句较为通顺：

提案需要包含适当的细节描述和影响范围，请尽可能地详述其需求。我们希望得到较完备的信息，原因如下：

tsunghanjacktsai · 2022-07-04T02:37:19Z

docs/29how-to-contribute.md

+
+Apache RocketMQ 社区成员主要通过以下两种邮件沟通和交流：
+
+*  [user mailing lists](mailto:[email protected]) ：Apache RocketMQ 用户 通过该邮件列表提问以寻求帮助或建议。您可以通过订阅该邮件系统以帮助他人解决问题来贡献社区。此外, 您还可以在 Stack Overflow 上检索 [rocketmq](https://stackoverflow.com/questions/tagged/rocketmq) 标签 回答用户的问题并获取更多见解。


此外, 您还可以在 Stack Overflow 上检索 rocketmq 标签回答用户的问题并获取更多见解。

这段可以用另一分点（Stack Overflow）陈述。

tsunghanjacktsai · 2022-07-04T02:51:23Z

docs/29how-to-contribute.md

+
+并请阅读 [AFS Apache 软件基金会 贡献者协议](https://www.apache.org/licenses/contributor-agreements.html) 提交电子签名
+
+万事俱备，只差 issue ？


这段过于口语化，可删除。

tsunghanjacktsai · 2022-07-04T03:04:53Z

docs/29how-to-contribute.md

+
+## 更多贡献途径...
+
+条条大路通罗马，还有更多贡献 RocketMQ 社区的方式等您选择！ 例如您可以：


条条大路通罗马，还有更多贡献 RocketMQ 社区的方式等您选择！例如您可以：

改为：

“您可以：“

tsunghanjacktsai · 2022-07-04T03:08:41Z

docs/30code-guidelines.md

+
+
+
+内容最好有点说明，至少简要说明为什么要这么做，还有就是 标题，简洁优雅还有切合主流说法


这段是否可以删除？

sorry, 这是草稿，我不小心提交的

tsunghanjacktsai · 2022-07-04T03:10:27Z

docs/31pull-request.md

+
+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] 开始并简要描述变更需求


pull request 摘要可以缩写为“PR摘要”，与其他用词一致。

tsunghanjacktsai · 2022-07-04T03:17:20Z

docs/31pull-request.md

+
+# 合并 PR
+
+开源项目开发分支合并由 committer 完成，所以，向上吧，少年！


这段过于口语化，可以进行删除。

tsunghanjacktsai · 2022-07-04T03:17:59Z

docs/31pull-request.md

+
+开源项目开发分支合并由 committer 完成，所以，向上吧，少年！
+
+① 合并 contributor PR


contributor改为贡献者，与前面用词保持一致。

liyijuan added 10 commits June 28, 2022 21:20

29how-to-contribute

19305ac

29how-to-contribute

84fb532

29how-to-contribute

9acc7c7

31pull-request

71c8c7a

31pull-request

5081c04

31pull-request

668a40d

30code-guidelines

15ab46e

31pull-request

1e3a480

RongtongJin approved these changes Jul 3, 2022

View reviewed changes

RongtongJin reviewed Jul 3, 2022

View reviewed changes

tsunghanjacktsai suggested changes Jul 4, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add pull request document for new official website #145

Add pull request document for new official website #145

liyijuan commented Jul 1, 2022

RongtongJin Jul 3, 2022

RongtongJin Jul 3, 2022

RongtongJin Jul 3, 2022

RongtongJin Jul 3, 2022

RongtongJin Jul 3, 2022

tsunghanjacktsai left a comment

tsunghanjacktsai Jul 4, 2022

tsunghanjacktsai Jul 4, 2022

tsunghanjacktsai Jul 4, 2022

tsunghanjacktsai Jul 4, 2022

tsunghanjacktsai Jul 4, 2022

tsunghanjacktsai Jul 4, 2022

tsunghanjacktsai Jul 4, 2022

liyijuan Jul 4, 2022

tsunghanjacktsai Jul 4, 2022

tsunghanjacktsai Jul 4, 2022

tsunghanjacktsai Jul 4, 2022

		制定并强制推行编码规则和编码指南，有助于提高代码的可读性，强化团队代码的所有权，

		帮助工程师快速且深入理解新增代码，简化维护的


		如何使开发分支相互可见？

		薅头发的请先住手，Linus 大神已经提供了解决方案 Git


		# Git 贡献指南

		① 复刻 [apache/rocketmq](https://github.com/apache/rocketmq) 仓库至个人 Github 远程仓库


		## 提出问题！

		Apache RocketMQ 社区提供完备的处理流程帮您解答问题。您可以通过 [user mailing list](https://rocketmq.apache.org/about/contact/) 和 [apache-rocketmq](https://stackoverflow.com/questions/tagged/rocketmq) 进行提问。


		社区在持续寻找反馈意见以改善 Apache RocketMQ ，您的改进方案或新特性的需求将惠及所有 RocketMQ 用户, 请在 github 上创建 [Github Issue](https://github.com/apache/rocketmq/issues)。

		提案需要包含适当的细节描述和影响范围，如果可能的话详述其需求。我们希望得到尽可能完备的信息，原因如下：


		Apache RocketMQ 社区成员主要通过以下两种邮件沟通和交流：

		* [user mailing lists](mailto:[email protected]) ：Apache RocketMQ 用户通过该邮件列表提问以寻求帮助或建议。您可以通过订阅该邮件系统以帮助他人解决问题来贡献社区。此外, 您还可以在 Stack Overflow 上检索 [rocketmq](https://stackoverflow.com/questions/tagged/rocketmq) 标签回答用户的问题并获取更多见解。


		并请阅读 [AFS Apache 软件基金会贡献者协议](https://www.apache.org/licenses/contributor-agreements.html) 提交电子签名

		万事俱备，只差 issue ？


		## 更多贡献途径...

		条条大路通罗马，还有更多贡献 RocketMQ 社区的方式等您选择！例如您可以：




		内容最好有点说明，至少简要说明为什么要这么做，还有就是标题，简洁优雅还有切合主流说法


		# 合并 PR

		开源项目开发分支合并由 committer 完成，所以，向上吧，少年！


		开源项目开发分支合并由 committer 完成，所以，向上吧，少年！

		① 合并 contributor PR

Add pull request document for new official website #145

Are you sure you want to change the base?

Add pull request document for new official website #145

Conversation

liyijuan commented Jul 1, 2022

What is the purpose of the change

Brief changelog

Verifying this change

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tsunghanjacktsai left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment