add code review #4236

tianshuo78520a · 2022-03-03T07:49:24Z

add code review

paddle-bot-old · 2022-03-03T07:50:07Z

Thanks for your contribution!

luotao1

dev_guides目录下需要新建一个git_guides，来放这里的所有文档。
有两个链接（编译和CI）需要等对应文档上传后，更新下链接
英文对应修改

luotao1 · 2022-03-04T06:43:17Z

docs/dev_guides/local_dev_guide_cn.md


 ```bash
-➜  pip install pre-commit
+➜  pip install pre-commit==1.10.4
 ➜  pre-commit install
 ```



clang-format要明确下是3.8版本，不是3.8以上

编译和单元测试，去掉单元测试。

（TODO）编译要跳到 @pangyoki 新的链接里，可以等目录做完后，再次调整。

好的，已经修改

luotao1 · 2022-03-04T06:48:58Z

docs/dev_guides/submit_pr_guide_cn.md

-## 建立 Issue 并完成 Pull Request
-
-建立一个 Issue 描述问题，并记录它的编号。
+## 完成 Pull Request PR创建


这张图可以裁剪掉一些分支么，太大了。

luotao1 · 2022-03-04T06:49:50Z

docs/dev_guides/submit_pr_guide_cn.md

@@ -16,6 +14,10 @@

 接下来等待 review，如果有需要修改的地方，参照上述步骤更新 origin 中的对应分支即可。

+### 关联Issue
+
+如果解决了某个Issue的问题创建的PR，需要关联Issue，参考[Code Reivew 约定](./code_review_cn.html)


19行可以合并到13行，都是关联issue，可以修改一下话术。去掉17-19行

话术合并后改成：
如果解决了某个Issue的问题创建的PR，需要关联Issue，参考Code Reivew 约定。并在 PR 的描述说明中，填写 resolve #Issue编号 可以在这个 PR 被 merge 后，自动关闭对应的 Issue，具体请见[这里]

luotao1 · 2022-03-04T06:52:08Z

docs/dev_guides/submit_pr_guide_cn.md

@@ -45,9 +47,7 @@



46行的【提交commit】链接，链接过去的不对。

luotao1 · 2022-03-04T06:52:37Z

docs/dev_guides/submit_pr_guide_cn.md

@@ -45,9 +47,7 @@

 请您关注您Pull Request中的CI单元测试进程，它将会在几个小时内完成


TODO：等 @lelelelelez 的CI文章merge后，这里加一下链接

luotao1 · 2022-03-04T07:01:52Z

docs/dev_guides/code_review_cn.md

@@ -0,0 +1,33 @@
+# Code Review 约定
+
+## 提交代码的一些约定


不需要第三行的小标题了

TCChenlong

全文 “您” -> 你

TCChenlong · 2022-03-07T01:37:02Z

docs/dev_guides/git_guides/submit_pr_guide_cn.md

+
+当所需的测试后都出现了绿色的对勾，表示您本次commit通过了各项单元测试，您只需要关注显示Required任务，不显示的可能是我们正在测试的任务
+
+如果所需的测试后出现了红色叉号，代表您本次的commit未通过某项单元测试，在这种情况下，请您点击detail查看报错详情，并将报错原因截图，以评论的方式添加在您的Pull Request中，我们的工作人员将帮您查看


这里应该是优先开发者自行解决吧？无法解决的时候再评论到评论区，一起看下

好的，已经修改

TCChenlong · 2022-03-07T01:37:57Z

docs/dev_guides/git_guides/submit_pr_guide_cn.md

+
+## 删除远程分支
+
+在 PR 被 merge 进主仓库后，我们可以在 PR 的页面删除远程仓库的分支。


我们 -> 你

TCChenlong · 2022-03-07T01:38:16Z

docs/dev_guides/git_guides/submit_pr_guide_cn.md

+
+### 签署CLA
+
+在首次向PaddlePaddle提交Pull Request时，您需要您签署一次CLA(Contributor License Agreement)协议，以保证您的代码可以被合入，具体签署方式如下：


您需要您签署一次CLA -> 你需要签署一次CLA

luotao1 · 2022-03-07T03:15:47Z

docs/dev_guides/git_guides/submit_pr_guide_cn.md

+
+![change_base](../guides/10_contribution/img/change_base.png)
+
+如果解决了某个Issue的问题创建的 PR，需要关联Issue，参考[Code Reivew 约定](./code_review_cn.html)。并在 PR 的描述说明中，填写 `resolve #Issue编号` 可以在这个 PR 被 merge 后，自动关闭对应的 Issue，具体请见[这里](https://help.github.com/articles/closing-issues-via-commit-messages/)。


复制这段吧：如果解决了某个Issue的问题，请在该PUll Request的第一个评论框中加上：fix #issue_number，这样当该PUll Request被合并后，会自动关闭对应的Issue。关键词包括：close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved，请选择合适的词汇。详细可参考Closing issues via commit messages

luotao1 · 2022-03-07T03:17:08Z

docs/dev_guides/git_guides/submit_pr_guide_cn.md

+
+选择目标分支：
+
+![change_base](../guides/10_contribution/img/change_base.png)


两张图都没有预览出来，可以删掉原来的图片，在git_guides目录下放上最新图片。

luotao1 · 2022-03-07T03:17:52Z

docs/dev_guides/git_guides/submit_pr_guide_cn.md

+
+在 PR 被 merge 进主仓库后，我们可以在 PR 的页面删除远程仓库的分支。
+
+![delete_branch](../guides/10_contribution/img/delete_branch.png)


图片没有预览出来

好的，之前添加了git_guides目录，导致路径不对了，已经修改

luotao1

https://github.com/PaddlePaddle/docs/tree/develop/docs/guides/10_contribution/img 下面的图片都可以挪到 docs/dev_guides/git_guides/img 下面
https://github.com/PaddlePaddle/docs/blob/develop/docs/guides/index_cn.rst 和 index_en.rst 里对应的内容可以去掉。
原来 https://github.com/PaddlePaddle/docs/tree/develop/docs/guides/10_contribution/ 下的其他内容，请 @TCChenlong 统一处理

luotao1 · 2022-03-07T09:05:05Z

docs/dev_guides/git_guides/submit_pr_guide_cn.md

+![change_base](../../guides/10_contribution/img/change_base.png)
+
+如果解决了某个Issue的问题创建的 PR，需要关联Issue，参考[Code Reivew 约定](./code_review_cn.html)。并在 PR 的描述说明中，填写 `resolve #Issue编号` 可以在这个 PR 被 merge 后，自动关闭对应的 Issue，具体请见[这里](https://help.github.com/articles/closing-issues-via-commit-messages/)。
+如果解决了某个Issue的问题，请在该PUll Request的第一个评论框中加上：fix #issue_number，这样当该PUll Request被合并后，会自动关闭对应的Issue。关键词包括：close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved，请选择合适的词汇。详细可参考[Closing issues via commit messages](https://help.github.com/articles/closing-issues-via-commit-messages/)


13行去掉，保留14行即可

luotao1 · 2022-03-07T09:05:31Z

docs/dev_guides/git_guides/submit_pr_guide_cn.md

+
+切换到所建分支，然后点击 `New pull request`。
+
+![new_pull_request](../../guides/10_contribution/img/new_pull_request.png)


目前这个图和原来的图比，有点模糊

New pull request有些老，已经找不到，改成了Compare & pull request

luotao1

LGTM 使用指南里的参与开发，请 @TCChenlong 统一调整

TCChenlong

LGTM

add code review

820b71d

tianshuo78520a added 3 commits March 3, 2022 17:04

Merge branch 'develop' of https://github.com/PaddlePaddle/docs into test

def16ab

add code review

d290a7f

dev_guides dir

3c575b0

luotao1 reviewed Mar 4, 2022

View reviewed changes

tianshuo78520a added 3 commits March 4, 2022 16:44

update docs

d9e88d4

update docs

83f4da5

update git_guides

72cc813

TCChenlong reviewed Mar 7, 2022

View reviewed changes

luotao1 reviewed Mar 7, 2022

View reviewed changes

tianshuo78520a added 2 commits March 7, 2022 14:41

fix docs

e94774b

fix diff

0976244

luotao1 reviewed Mar 7, 2022

View reviewed changes

tianshuo78520a added 4 commits March 7, 2022 19:10

fix

33e53f1

fix

fef5fed

fix

d82b53e

fix

2b06230

luotao1 approved these changes Mar 8, 2022

View reviewed changes

TCChenlong approved these changes Mar 8, 2022

View reviewed changes

TCChenlong merged commit d06c389 into PaddlePaddle:develop Mar 8, 2022

RichardWooSJTU pushed a commit to RichardWooSJTU/docs that referenced this pull request Apr 8, 2022

Update profiler (PaddlePaddle#4236)

9468657

sunzhongkai588 mentioned this pull request May 22, 2024

[Docathon][Remove File No.46] #6618

Closed

		@@ -45,9 +47,7 @@

		请您关注您Pull Request中的CI单元测试进程，它将会在几个小时内完成

		@@ -0,0 +1,33 @@
		# Code Review 约定

		## 提交代码的一些约定


		当所需的测试后都出现了绿色的对勾，表示您本次commit通过了各项单元测试，您只需要关注显示Required任务，不显示的可能是我们正在测试的任务

		如果所需的测试后出现了红色叉号，代表您本次的commit未通过某项单元测试，在这种情况下，请您点击detail查看报错详情，并将报错原因截图，以评论的方式添加在您的Pull Request中，我们的工作人员将帮您查看


		## 删除远程分支

		在 PR 被 merge 进主仓库后，我们可以在 PR 的页面删除远程仓库的分支。


		### 签署CLA

		在首次向PaddlePaddle提交Pull Request时，您需要您签署一次CLA(Contributor License Agreement)协议，以保证您的代码可以被合入，具体签署方式如下：


		![change_base](../guides/10_contribution/img/change_base.png)

		如果解决了某个Issue的问题创建的 PR，需要关联Issue，参考[Code Reivew 约定](./code_review_cn.html)。并在 PR 的描述说明中，填写 `resolve #Issue编号` 可以在这个 PR 被 merge 后，自动关闭对应的 Issue，具体请见[这里](https://help.github.com/articles/closing-issues-via-commit-messages/)。


		选择目标分支：

		![change_base](../guides/10_contribution/img/change_base.png)


		在 PR 被 merge 进主仓库后，我们可以在 PR 的页面删除远程仓库的分支。

		![delete_branch](../guides/10_contribution/img/delete_branch.png)


		切换到所建分支，然后点击 `New pull request`。

		![new_pull_request](../../guides/10_contribution/img/new_pull_request.png)

add code review #4236

add code review #4236

Uh oh!

Conversation

tianshuo78520a commented Mar 3, 2022 • edited by TCChenlong Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

paddle-bot-old bot commented Mar 3, 2022

Uh oh!

luotao1 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

luotao1 Mar 4, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TCChenlong left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

luotao1 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

luotao1 left a comment

Choose a reason for hiding this comment

Uh oh!

TCChenlong left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tianshuo78520a commented Mar 3, 2022 •

edited by TCChenlong

Loading

luotao1 Mar 4, 2022 •

edited

Loading