Skip to content

Commit b77b3e3

Browse files
committed
docs: refine code review guidelines
1 parent d4e64c6 commit b77b3e3

File tree

1 file changed

+10
-10
lines changed
  • website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/contribution

1 file changed

+10
-10
lines changed

website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/contribution/code-review-guide.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: 'code-review-guide'
33
title: 'Code Review 指南'
44
---
55

6-
本指南适用于所有希望协助代码贡献评审的提交者和贡献者。感谢您的付出——优质的评审是开源项目中最重要且关键的环节之一。本指南旨在帮助社区实现以下评审目标:
6+
本指南适用于所有希望协助代码贡献评审的提交者和贡献者。感谢您的付出优质的评审是开源项目中最重要且关键的环节之一。本指南旨在帮助社区实现以下评审目标:
77

88
- 让贡献者获得良好的贡献体验。
99
- 确保代码审查结构化,全面覆盖贡献的核心要点。
@@ -12,23 +12,23 @@ title: 'Code Review 指南'
1212

1313
## Code Review 指南
1414

15-
- 始终保持一个较高的标准来进行 review,这样才能更好地保证整个产品的质量。
16-
- 对于接口类的、整体架构方面的修改,需要在社区进行充分地讨论,可以在邮件组发起,也可以在 issue 上发起。
15+
- 始终保持一个较高的标准来进行审核,这样才能更好地保证整个产品的质量。
16+
- 对于接口类的、整体架构方面的修改,需要在社区进行充分地讨论,可以在邮件组发起,也可以在 Issue 上发起。
1717
- 测试覆盖。新增的逻辑需要有对应的测试来覆盖。对于已有老代码,不好增加的可以酌情考虑。
18-
- 文档。新增加的功能必须要有文档来说明,否则这样的代码不允许合入。必须要有英文文档,最好有中文文档。
19-
- 代码的可读性。如果 reviewer 对于代码逻辑不是很清晰,那么可以要求 contributor 去解释这段逻辑,并且需要在代码里写充分的注释来解释逻辑。
18+
- 文档。新增加的功能必须要有文档来说明,否则这样的代码不允许合并。必须要有英文文档,最好有中文文档。
19+
- 代码的可读性。如果 Reviewer 对于代码逻辑不是很清晰,那么可以要求 Contributor 去解释这段逻辑,并且需要在代码里写充分的注释来解释逻辑。
2020
- 尽量在评论的结尾给出明确的结论。是同意,还是要 change request。如果是小问题,可以只留评论。
21-
- 如果你已经看过了代码,觉得没有问题,但是觉得需要其他同学来确认下,可以留下 +1 Comment。
21+
- 如果已经看过了代码,觉得没有问题,但是觉得还需要其他 Reviewer 来确认下,可以留下 +1 Comment。
2222
- 互相尊重,互相学习。在评论的时候保持礼貌的口吻,提建议尽量给出建议的理由。
2323

2424
## PR Review 指南
2525

26-
- 检查贡献内容是否描述充分,足以支持高质量的评审
26+
- 检查贡献内容是否描述充分,足以支持高质量的评审
2727
- Reviewer 需进行代码层级的评审。
2828
- Reviewer 对 PR 发表评论后,需持续跟进该 PR 后续的修改。
29-
- 一个 PR 至少要获得一个 **非作者外的 Committer +1** 才能允许进行被合入
30-
- PR 获得第一个 +1 后,建议等待 **一个工作日** 后才进行合入。主要目的是等待社区其他同学来进行 review
29+
- 每个 PR 至少要获得一个 **非作者外的 Committer +1** 才能允许进行被合并
30+
- PR 获得第一个 +1 后,建议等待 **一个工作日** 后才进行合并。主要目的是等待社区其他 Reviewer 来进行审核
3131
- 对于接口类、整体架构方面等被认为是重大变更,则至少要获得 **3 个 +1** 才能进行合并。
3232
- 合并前需确保回归测试与持续集成测试全部通过。
3333
- 合并时请选择“squash and merge”操作。
34-
- 对于一个修改不同的 reviewer 有争议时,可以尝试讨论解决。如果讨论没有办法解决,可通过`[email protected]`发起邮件投票解决,采取少数服从多数的原则。
34+
- 不同的 Reviewer 对 PR 有争议时,可以尝试讨论解决。如果讨论无法解决,可通过`[email protected]`发起邮件投票解决,采取少数服从多数的原则。

0 commit comments

Comments
 (0)