Skip to content

Commit f9198dc

Browse files
authored
docs: fix typos and refine the content description (#624)
* docs: refine committer documentation and fix typos * docs: update ICLA guide with formatting and clarity improvements * docs: update Apache ID references in onboarding docs * docs: update committer nomination guide * docs: refine code review guidelines * docs: update mailing list subscription link
1 parent ed014d4 commit f9198dc

File tree

8 files changed

+31
-31
lines changed

8 files changed

+31
-31
lines changed

website/community/committer/become-committer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Anyone being supportive of the community and working in any of the CoPDoC areas
1313
of the authors
1414
- **(C)ode** - discussion goes nowhere without code
1515

16-
Apache Fesod (Incubating) community strives to be meritocratic. Thus, once someone has contributed sufficiently to any area of CoPDoC they can be a candidate for committer-ship and at last voted in as an Apache Fesod (Incubating) committer. Being an Apache Fesod (Incubating) committer does not necessarily mean you must commit code with your commit privilege to the codebase; it means you are committed to the Apache Fesod (Incubating) project and are productively contributing to our community's success.
16+
Apache Fesod (Incubating) community strives to be meritocratic. Thus, once someone has contributed sufficiently to any area of CoPDoC they can be a candidate for committer-ship and at last voted in as an Apache Fesod (Incubating) committer. Being an Apache Fesod (Incubating) committer does not necessarily mean you must commit code with your commit privilege to the codebase, it means you are committed to the Apache Fesod (Incubating) project and are productively contributing to our community's success.
1717

1818
## Committer requirements
1919

website/community/committer/icla.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Fill in the following columns in English.
4141

4242
- (optional) preferred Apache id(s)
4343

44-
You need to choose a unique ApacheID that hasn't been taken. Check [ASF Committers by ID](https://people.apache.org/committer-index.html) to see which IDs are still available.
44+
You need to choose a unique Apache ID that hasn't been taken. Check [ASF Committers by ID](https://people.apache.org/committer-index.html) to see which IDs are still available.
4545

4646
- (optional) notify project:
4747

website/community/committer/onboarding.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ We require all contributors to sign a Contributor License Agreement (CLA). This
1717

1818
## Setup ASF Account
1919

20-
Go to [Apache Account Utility](https://id.apache.org/reset/enter) and enter your ApacheID.
20+
Go to [Apache Account Utility](https://id.apache.org/reset/enter) and enter your Apache ID.
2121

2222
![Reset Password](/img/community/reset-passwd.png)
2323

@@ -27,13 +27,13 @@ After clicking "Send Email", a prompt will appear indicating that the email has
2727

2828
![Link GitHub](/img/community/link-github.png)
2929

30-
1. Navigate to [ASF Boxer](https://gitbox.apache.org/boxer/) and enter your ApacheID and password.
30+
1. Navigate to [ASF Boxer](https://gitbox.apache.org/boxer/) and enter your Apache ID and password.
3131
2. Click "Link GitHub username to ASF id" and follow the given instructions to link your ASF account to GitHub.
3232
3. Check your email titled "[GitHub] @asfgit has invited you to join the @apache organization" and accept the invitation.
3333
4. Wait momentarily, and the website will refresh on its own.
3434
5. (If you do not enable 2FA on GitHub) Please follow the [instruction](https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication).
3535

36-
Your ApacheID and GitHub ID will now both appear on [ASF Boxer](https://gitbox.apache.org/boxer/). Congrats on successfully linking your ASF account to GitHub!
36+
Your Apache ID and GitHub ID will now both appear on [ASF Boxer](https://gitbox.apache.org/boxer/). Congrats on successfully linking your ASF account to GitHub!
3737

3838
## Email Settings
3939

website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/committer/become-committer.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ title: '如何成为 Committer'
1010
- **(Do)cumentation** - 没有它,内容只会停留在作者的头脑中。
1111
- **(C)ode** - 没有代码,讨论就毫无意义。
1212

13-
Apache Fesod (Incubating) 社区努力追求基于功绩的原则。因此,一旦有人在 CoPDoC 的任何领域有了足够的贡献,他们就可以成为 Committer 的候选人,最终被投票选为 Apache Fesod (Incubating) 的 Committer。成为 Apache Fesod (Incubating) 的 Committer 并不一定意味着你必须使用你的提交权限向代码库提交代码它意味着你致力于 Apache Fesod (Incubating) 项目并为我们社区的成功做出了积极的贡献。
13+
Apache Fesod (Incubating) 社区努力追求基于功绩的原则。因此,一旦有人在 CoPDoC 的任何领域有了足够的贡献,他们就可以成为 Committer 的候选人,最终被投票选为 Apache Fesod (Incubating) 的 Committer。成为 Apache Fesod (Incubating) 的 Committer 并不一定意味着你必须使用你的提交权限向代码库提交代码它意味着你致力于 Apache Fesod (Incubating) 项目并为我们社区的成功做出了积极的贡献。
1414

1515
## Committer 的要求
1616

@@ -37,19 +37,19 @@ Committer 的候选人应该持续参与并为 Apache Fesod (Incubating) 做出
3737
## 日常工作
3838

3939
- 查看社区待处理的 Pull Request 和 Issue 列表,负责问题的处理
40-
- 包括标记 issue,回复 issue,关闭 issue 等;
40+
- 包括标记、回复、关闭 issue 等;
4141
- 将 issue 分配至熟悉该模块的贡献者;
42-
- Assignee 在被分配 issue 后,需要进行如下判断:
42+
- 分配 issue 后,需要进行如下判断:
4343
- 判断是否是长期 issue,如是,则标记为 `pending`
4444
- 判断 issue 类型,如:bug,enhancement,discussion 等;
4545
- 标记 Milestone。
4646
- Committer 提交的 PR,需要根据 PR 类型和当前发布的周期标注 Label 和 Milestone。
47-
- Committer review PR 时,可以进行 squash and merge to master 的操作,如果有问题可以加上 change request 或者 @ 相关人员协助处理。
47+
- Committer 审核通过 PR 时,可以进行 squash and merge 的操作,如果有问题可以加上 change request 或者 @ 相关人员协助处理。
4848

4949
## 福利权益
5050

5151
每个 Apache Committer 都有资格获得免费 JetBrains 订阅,使他们能够访问 JetBrains 产品包,如 IntelliJ IDEA、PyCharm 和其他桌面工具。
5252

53-
如果您是 Apache ShardingSphere 提交者,但未收到免费的 JetBrains 订阅,请使用您的 @apache.org 电子邮件地址 [All Products Packs for Apache committers](https://www.jetbrains.com/shop/eform/apache?product=ALL) 以便于 Apache Fesod (Incubating) 的后续开发。
53+
如果您已是一名 Apache Committer,但未收到免费的 JetBrains 订阅,请使用您的 @apache.org 电子邮件地址 [All Products Packs for Apache committers](https://www.jetbrains.com/shop/eform/apache?product=ALL) 以便于 Apache Fesod (Incubating) 的后续开发。
5454

5555
如果您已经使用了免费的 JetBrains 订阅,遇到 License 到期,可以使用您的 @apache.org 电子邮件地址 续订免费的所有产品包,并在您的 JetBrains 桌面工具(例如 IntelliJ IDEA) 中点击 `Refresh license list` 刷新订阅。

website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/committer/icla.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ id: 'icla'
33
title: '签署 ICLA 指南'
44
---
55

6-
Apache CLA 是 Apache贡 献者许可协议的缩写,该协议旨在明确界定向ASF贡献知识产权的条款,从而使我们在未来软件发生法律纠纷时能够为项目提供法律保障。个人在获得任何ASF项目的提交权限前,必须提交经签署的ICLA文件存档
6+
Apache CLA 是 Apache贡献者许可协议的缩写,该协议旨在明确界定向ASF贡献知识产权的条款,从而使我们在未来软件发生法律纠纷时能够为项目提供法律保障。个人在获得任何 ASF 项目的提交权限前,必须提交经签署的 ICLA 文件存档
77

88
提交 ICLA 的流程如下:
99

1010
## 下载模板
1111

12-
点击链接[贡献者许可协议](https://www.apache.org/licenses/contributor-agreements.html#clas)在贡献者许可协议部分找到ICLA
12+
点击链接[贡献者许可协议](https://www.apache.org/licenses/contributor-agreements.html#clas)在贡献者许可协议部分找到 ICLA
1313

1414
![ICLA](/img/community/icla-01.png)
1515

@@ -21,15 +21,15 @@ Apache CLA 是 Apache贡 献者许可协议的缩写,该协议旨在明确界
2121

2222
- 全名
2323

24-
请填写真实姓名。名字在前,姓氏在后。每个单词的首字母需大写。(注:姓氏与名字之间需留空格,请注意首字母大写,姓氏需置于首位。)
24+
请填写真实姓名。名字在前,姓氏在后。每个单词的首字母需大写。
2525

2626
- 公开名称
2727

28-
公开名称应为真实姓名或笔名,不可使用用户ID
28+
公开名称应为真实姓名或笔名,不能和 Apache ID 重复
2929

3030
- 邮寄地址
3131

32-
英文地址需详细至门牌号
32+
英文地址,且需详细至门牌号
3333

3434
- 国家
3535

website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/committer/onboarding.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: 'committer-onboarding'
33
title: 'Committer 须知'
44
---
55

6-
收到 Apache Fesod (Incubating) PMC 的邀请邮件后,新的 Committer 应考虑是否接受邀请。
6+
收到 Apache Fesod (Incubating) PPMC 的邀请邮件后,新的 Committer 应考虑是否接受邀请。
77

88
若决定接受,请选择 **回复所有** 并表明最终决定。回复邮件请包含以下参考内容:
99

@@ -33,7 +33,7 @@ Hi, i accept. Thanks for invitaion.
3333
4. 请稍候片刻,网站将自动刷新。
3434
5. (若您尚未在GitHub启用双重验证)请遵循[操作指南](https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication)
3535

36-
您的 ApacheID 和 GitHub ID 现已同时显示在 [ASF Boxer](https://gitbox.apache.org/boxer/) 上。恭喜您成功将 ASF 账户与 GitHub 关联!
36+
您的 Apache ID 和 GitHub ID 现已同时显示在 [ASF Boxer](https://gitbox.apache.org/boxer/) 上。恭喜您成功将 ASF 账户与 GitHub 关联!
3737

3838
## 邮箱设置
3939

@@ -64,7 +64,7 @@ Hi, i accept. Thanks for invitaion.
6464

6565
### 订阅邮件列表
6666

67-
请参考 [订阅邮件列表](../index.md#how-to-subscribe-to-a-mailing-list)
67+
请参考 [订阅邮件列表](../index.md#如何订阅邮件列表)
6868

6969
## 在 GitHub 上启用双因素认证
7070

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]`发起邮件投票解决,采取少数服从多数的原则。

website/i18n/zh-cn/docusaurus-plugin-content-docs-community/current/pmc/nominate-committer.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Best regards,
5151
${NOMINATOR}
5252
```
5353

54-
投票将在今天**一周后**结束, 即:
54+
投票将在今天开始的**一周后**结束, 即:
5555

5656
- [midnight UTC on YYYY-MM-DD](https://www.timeanddate.com/counters/customcounter.html?year=YYYY&month=MM&day=DD)
5757
- [Apache Voting Guidelines](https://community.apache.org/newcommitter.html)
@@ -172,7 +172,7 @@ establishing you as a committer.
172172
${NOMINATOR} (as represents of The Apache Fesod (Incubating) PPMC)
173173
```
174174

175-
## 该候选人接受了邀请
175+
## 候选人接受邀请
176176

177177
如果接受邀请,该候选人将会收到来自 ASF 的一封电子邮件。
178178

@@ -228,7 +228,7 @@ The Apache Fesod (Incubating) PPMC
228228

229229
## 将候选人添加至提交者名单
230230

231-
候选人接受邀请并完成iCLA记录后,请通过whimsy roster tools](<https://whimsy.apache.org/roster/committee/fesod)将其添加至提交者名单。>
231+
候选人接受邀请并完成iCLA记录后,请通过[whimsy roster tools](https://whimsy.apache.org/roster/committee/fesod)将其添加至提交者名单。
232232

233233
![Roster](/img/community/roster-add-committer.png)
234234

0 commit comments

Comments
 (0)