Skip to content

Commit d2359fd

Browse files
committed
[zh] update contributing/_index.md
Signed-off-by: Dariel Li <[email protected]>
1 parent 316d691 commit d2359fd

File tree

1 file changed

+48
-69
lines changed

1 file changed

+48
-69
lines changed

content/zh/docs/contributing/_index.md

Lines changed: 48 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
11
---
22
title: 贡献
3-
description: 了解如何为OpenTelemetry文档做贡献.
4-
aliases: [/docs/contribution-guidelines]
3+
description: 了解如何为OpenTelemetry文档做贡献。
54
weight: 980
6-
cSpell:ignore: prepopulated spacewhite
5+
default_lang_commit: 8603bc8
76
---
87

9-
下面的指引描述了如何为OpenTelemetry文档做贡献。
10-
11-
关于如何为 OpenTelemetry项目作出贡献,请参阅[OpenTelemetry贡献者指南](https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md),其中提供了有关贡献者许可协议和行为准则的详细信息。从某种程度上讲,每种语言实现、收集器和约定 [仓库](https://github.com/open-telemetry/) 都有自己特定的贡献指南。
8+
下面的指引描述了如何为OpenTelemetry文档做贡献。关于如何为 OpenTelemetry项目作出贡献,请参阅[OpenTelemetry贡献者指南](https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md),其中提供了有关贡献者许可协议和行为准则的详细信息。从某种程度上讲,每种语言实现、收集器和约定 [仓库](https://github.com/open-telemetry/) 都有自己特定的贡献指南。
129

1310
对于文档中的问题,你可以提一个关于OpenTelemetry的问题(issue),或者向[`opentelemetry.io` GitHub 仓库](https://github.com/open-telemetry/opentelemetry.io)发起一个带有变更的拉取请求(pull request)。
1411

@@ -23,12 +20,12 @@ OpenTelemetry文档贡献者可以:
2320

2421
在贡献之前,你需要了解以下的技术和工具:
2522

26-
- [git](https://git-scm.com/)
27-
- [GitHub](https://github.com/)
28-
- Markdown ([CommonMark](https://commonmark.org/))
29-
- YAML
23+
* [git](https://git-scm.com/)
24+
* [GitHub](https://github.com/)
25+
* Markdown ([CommonMark](https://commonmark.org/))
26+
* YAML
3027

31-
有关如何在本地构建和测试Opentelemetry文档网站的技术细节,请参阅 [CONTRIBUTING.md](https://github.com/open-telemetry/opentelemetry.io/blob/main/CONTRIBUTING.md)文档。
28+
有关如何在本地构建和测试OpenTelemetry文档网站的技术细节,请参阅 [CONTRIBUTING.md](https://github.com/open-telemetry/opentelemetry.io/blob/main/CONTRIBUTING.md)文档。
3229

3330
### 签署CNCF CLA {#sign-the-cla}
3431

@@ -44,7 +41,7 @@ flowchart LR
4441
direction TB
4542
T[ ] -.-
4643
B[在GitHub克隆(fork)仓库] --- C[用markdown编写文档<br>并用Hugo构建网站]
47-
C --- D[提交源文件到复制的仓库]
44+
C --- D[提交源文件到克隆的仓库]
4845
D --- E[发起拉取请求(PR)]
4946
E --- F[签署 CNCF CLA]
5047
end
@@ -56,7 +53,6 @@ class A,B,C,D,E,F,G,H grey
5653
class S,T spacewhite
5754
class first,second white
5855
```
59-
6056
_图 1. 贡献新的内容。_
6157

6258
上图描述了如何贡献新的文档。
@@ -103,9 +99,6 @@ class 0 spacewhite
10399
class tasks,tasks2 white
104100
class id1 k8s
105101
```
106-
107-
108-
109102
_图 2. 使用Github发起拉取请求的流程。_
110103

111104
1. 在发现问题的页面上,选择右侧导航面板中的**Edit this page**选项。
@@ -117,8 +110,6 @@ _图 2. 使用Github发起拉取请求的流程。_
117110
7. 进入**Open a pull request**页面,填写描述可以帮助评审人理解你的更改内容。
118111
8. 选择**Create pull request**
119112

120-
121-
122113
合并拉取请求需要OpenTelemetry 社区成员评审和批准。
123114

124115
如果评审人要求你进行修改:
@@ -136,8 +127,6 @@ _图 2. 使用Github发起拉取请求的流程。_
136127

137128
{{% /alert %}}
138129

139-
140-
141130
### 在本地分支进行更改 {#fork-the-repo}
142131

143132
如果你有使用 Git 的经验,或者你的更改较多,请在本地分支进行更改。
@@ -188,13 +177,13 @@ _图 3. 在本地分支进行更改_。
188177
npm install
189178
```
190179

191-
1.`open-telemetry/opentelemetry.io` 仓库设置为你的远程 `upstream`仓库:
180+
2.`open-telemetry/opentelemetry.io` 仓库设置为你的远程 `upstream`仓库:
192181

193182
```shell
194183
git remote add upstream https://github.com/open-telemetry/opentelemetry.io.git
195184
```
196185

197-
1. 确认你的 `origin``upstream` 仓库:
186+
3. 确认你的 `origin``upstream` 仓库:
198187

199188
```shell
200189
git remote -v
@@ -209,7 +198,7 @@ _图 3. 在本地分支进行更改_。
209198
upstream https://github.com/open-telemetry/opentelemetry.io.git (push)
210199
```
211200

212-
1. 从你克隆的 `origin/main` and`open-telemetry/opentelemetry.io`'s `upstream/main`获取提交:
201+
4. 从你克隆的 `origin/main` and`open-telemetry/opentelemetry.io`'s `upstream/main`获取提交:
213202

214203
```shell
215204
git fetch origin
@@ -226,7 +215,7 @@ _图 3. 在本地分支进行更改_。
226215
git checkout -b <my_new_branch> upstream/main
227216
```
228217

229-
1. 使用代码或文本编辑器进行编辑或更改。
218+
2. 使用代码或文本编辑器进行编辑或更改。
230219

231220
使用 `git status`命令可以随时查看您更改的文件。
232221

@@ -255,27 +244,27 @@ _图 3. 在本地分支进行更改_。
255244
no changes added to commit (use "git add" and/or "git commit -a")
256245
```
257246

258-
1.**Changes not staged for commit** 下列出的文件添加到提交中:
247+
2.**Changes not staged for commit** 下列出的文件添加到提交中:
259248

260249
```shell
261250
git add <your_file_name>
262251
```
263252

264253
对每个文件重复此操作。
265254

266-
1. 添加所有文件后,创建提交:
255+
3. 添加所有文件后,创建提交:
267256

268257
```shell
269258
git commit -m "你的提交信息"
270259
```
271260

272-
1. 将你的本地分支及其新的提交推送到你的远程分支:
261+
4. 将你的本地分支及其新的提交推送到你的远程分支:
273262

274263
```shell
275264
git push origin <my_new_branch>
276265
```
277266

278-
1. 更改被推送后,GitHub 会通知你可以创建 PR。
267+
5. 更改被推送后,GitHub 会通知你可以创建 PR。
279268

280269
#### 从你的 fork 中发起拉取请求 {#open-a-pr}
281270

@@ -316,16 +305,16 @@ _图 4. 从你的 fork 向 [opentelemetry.io](https://github.com/open-telemetry/
316305
* **Title**(不多于50 个字符):总结更改的目的。
317306
* **Description**:更详细地描述更改。
318307
* 如果有相关的 GitHub 问题(issue),请在描述中包含 `Fixes #12345``Closes #12345`,以便 GitHub 的自动化功能在合并 PR 后关闭提到的问题。如果还有其他相关 PR,也请链接它们。
319-
* 如果你需要有关特定内容的建议,请在描述中包含你希望评审人任何问题
308+
* 如果你需要有关特定内容的建议,请在描述中包含你希望评审人考虑的任何问题
320309

321310
8. 选择 **Create pull request** 按钮。
322311

323312
您的拉取请求可以在[Pull requests](https://github.com/open-telemetry/opentelemetry.io/pulls) 中找到。
324313

325314
发起 PR 后,GitHub 会运行自动测试并尝试使用 [Netlify](https://www.netlify.com/) 部署预览。
326315

327-
- 如果 Netlify 构建失败,选择 **详细信息** 可以获取更多信息。
328-
- 如果 Netlify 构建成功,选择 **详细信息** 可以打开 OpenTelemetry 网站的暂存版本,其中应用了您的更改。评审人通过这种方式检查你的更改。
316+
* 如果 Netlify 构建失败,选择 **详细信息** 可以获取更多信息。
317+
* 如果 Netlify 构建成功,选择 **详细信息** 可以打开 OpenTelemetry 网站的暂存版本,其中应用了您的更改。评审人通过这种方式检查你的更改。
329318

330319
其他检查也可能失败。请参阅[所有 PR 检查列表](/docs/contributing/pr-checks)
331320

@@ -360,8 +349,6 @@ npm run serve
360349

361350
要停止本地 Hugo 实例,请返回终端并键入 `Ctrl+C`,或关闭终端窗口。
362351

363-
364-
365352
#### 站点部署和 PR 预览
366353

367354
如果你提交了 PR,Netlify 会创建一个 [部署预览][],以便你可以查看你的更改。一旦你的 PR 合并,Netlify 就会将更新后的站点部署到生产服务器。
@@ -370,15 +357,13 @@ npm run serve
370357
371358
要查看部署日志等,请访问项目的 [仪表板][]——需要 Netlify 登录。
372359

373-
374-
375360
#### PR 指南
376361

377362
在 PR 合并之前,有时需要进行几次评审和编辑。为了帮助我们和你自己尽可能简化此过程,我们要求你遵守以下规定:
378363

379-
- 如果你的 PR 不是一个快速的问题修复,则从 **在本地分支进行更改**开始:单击仓库顶部的[Fork](https://github.com/open-telemetry/opentelemetry.io/fork) 按钮并创建一个你自己本地的克隆仓库。当你准备好更改内容时,向上游仓库发起PR请求。
380-
- **不要在你克隆仓库的 `main`** 分支上直接进行更改,而应该创建一个特定于 PR 的分支。
381-
- 确保维护人员[可以对您的拉取请求应用更改](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)
364+
* 如果你的 PR 不是一个快速的问题修复,则从 **在本地分支进行更改**开始:单击仓库顶部的[Fork](https://github.com/open-telemetry/opentelemetry.io/fork) 按钮并创建一个你自己本地的克隆仓库。当你准备好更改内容时,向上游仓库发起PR请求。
365+
* **不要在你克隆仓库的 `main`** 分支上直接进行更改,而应该创建一个特定于 PR 的分支。
366+
* 确保维护人员[可以对您的拉取请求应用更改](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)
382367

383368
#### 评审人的更改
384369

@@ -391,7 +376,7 @@ npm run serve
391376
git rebase origin/<your-branch-name>
392377
```
393378

394-
1. 重定基后,强制将新的更改推送到你的 fork 中:
379+
2. 重定基后,强制将新的更改推送到你的 fork 中:
395380

396381
```shell
397382
git push --force-with-lease origin <your-branch-name>
@@ -401,8 +386,7 @@ npm run serve
401386

402387
#### 合并冲突和重定基
403388

404-
如果另一个贡献者在另一个 PR 中提交对同一文件的更改,则可能会
405-
产生合并冲突。您必须解决 PR 中的所有合并冲突。
389+
如果另一个贡献者在另一个 PR 中提交对同一文件的更改,则可能会产生合并冲突。您必须解决 PR 中的所有合并冲突。
406390

407391
1. 更新你的 fork 并重定基你的本地分支:
408392

@@ -417,38 +401,37 @@ npm run serve
417401
git push --force-with-lease origin <your-branch-name>
418402
```
419403

420-
1.`open-telemetry/opentelemetry.io``upstream/main` 获取更改并重定基您的分支:
404+
2.`open-telemetry/opentelemetry.io``upstream/main` 获取更改并重定基您的分支:
421405

422406
```shell
423407
git fetch upstream
424408
git rebase upstream/main
425409
```
426410

427-
1. 检查重定基的结果:
411+
3. 检查重定基的结果:
428412

429413
```shell
430414
git status
431415
```
432416

433417
这会导致许多文件被标记为冲突。
434418

435-
1. 打开每个有冲突的文件并查找冲突标记:`>>>``<<<``===`。解决冲突并删除冲突标记。
419+
4. 打开每个有冲突的文件并查找冲突标记:`>>>``<<<``===`。解决冲突并删除冲突标记。
436420

437421
更多有关信息,请参阅[如何冲突是如何呈现的](https://git-scm.com/docs/git-merge#_how_conflicts_are_presented)
438422

439-
1. 将文件添加到变更集:
423+
5. 将文件添加到变更集:
440424

441425
```shell
442426
git add <filename>
443427
```
444428

445-
1. 继续重定基:
429+
6. 继续重定基:
446430

447431
```shell
448432
git rebase --continue
449433
```
450-
451-
434+
452435
7. 根据需要重复步骤 2 至 5。
453436

454437
应用所有提交后, `git status`命令显示重定基已完成。
@@ -465,11 +448,11 @@ npm run serve
465448

466449
合并拉取请求需要符合以下条件:
467450

468-
- 审批者、维护者、技术委员会成员或主题专家的所有评审状态均为“Approved”。
469-
- 没有未解决的对话。
470-
- 至少获得一名审批者的批准。
471-
- 没有失败的 PR 检查项。
472-
- PR 分支与基础分支保持同步。
451+
* 审批者、维护者、技术委员会成员或主题专家的所有评审状态均为“Approved”。
452+
* 没有未解决的对话。
453+
* 至少获得一名审批者的批准。
454+
* 没有失败的 PR 检查项。
455+
* PR 分支与基础分支保持同步。
473456

474457
> **重要**
475458
>
@@ -493,24 +476,22 @@ npm run serve
493476

494477
1. 转到[GitHub](https://github.com/open-telemetry/opentelemetry.io/issues/new/) 并在 **Issues** 选项卡中选择 **New issue**
495478

496-
1. 选择最适合您的请求或疑问的问题类型。
479+
2. 选择最适合您的请求或疑问的问题类型。
497480

498-
1. 填写模板。
481+
3. 填写模板。
499482

500-
1. 提交问题。
483+
4. 提交问题。
501484

502485
### 如何填写好的问题(issue):
503486

504487
填写问题(issue)时请注意以下几点:
505488

506-
- 提供清晰的问题描述。描述具体哪些内容出现缺失、过时、错误或需要改进的情况。
507-
- 解释该问题对用户的具体影响。
508-
- 将给定问题的范围限制在合理的工作单元内。对于范围较大的问题,将其分解为较小的问题。例如,“修复安全文档”太宽泛,而“向‘限制网络访问’主题添加详细信息”则非常具体并且可操作。
509-
- 搜索现有问题,查看是否有任何与新问题相关或类似的内容。
510-
- 如果新问题与另一个问题或拉取请求相关,请通过其完整 URL 或以`#`字符为前缀的问题或拉取请求编号来引用它。例如,`由 #987654 引入`
511-
- 遵守 [行为准则](https://github.com/open-telemetry/community/blob/main/code-of-conduct.md)。 尊重您的其他贡献者。例如,“文档很糟糕”不是一个有帮助或有礼貌的反馈。
512-
513-
489+
* 提供清晰的问题描述。描述具体哪些内容出现缺失、过时、错误或需要改进的情况。
490+
* 解释该问题对用户的具体影响。
491+
* 将给定问题的范围限制在合理的工作单元内。对于范围较大的问题,将其分解为较小的问题。例如,“修复安全文档”太宽泛,而“向‘限制网络访问’主题添加详细信息”则非常具体并且可操作。
492+
* 搜索现有问题,查看是否有任何与新问题相关或类似的内容。
493+
* 如果新问题与另一个问题或拉取请求相关,请通过其完整 URL 或以`#`字符为前缀的问题或拉取请求编号来引用它。例如,`由 #987654 引入`
494+
* 遵守 [行为准则](https://github.com/open-telemetry/community/blob/main/code-of-conduct.md)。 尊重您的其他贡献者。例如,“文档很糟糕”不是一个有帮助或有礼貌的反馈。
514495

515496
## 公告管理
516497

@@ -554,13 +535,11 @@ OpenTelemetry 是一个开源项目,我们很乐意接受新的贡献和贡献
554535

555536
大多数存储库使用issue和 PR 模板。查看一些未解决的问题和 PR可以帮助了解该团队的流程。提交问题或 PR 时,请确保尽可能详细地填写模板。
556537

557-
558-
559538
## 其他贡献的方式
560539

561-
- 访问 [OpenTelemetry 社区网站](/community/)
562-
- 将您的应用程序添加到[注册表(Registry)](/ecosystem)
563-
- 提交[博客文章或案例研究](/docs/contributing/blog/)
540+
* 访问 [OpenTelemetry 社区网站](/community/)
541+
* 将您的应用程序添加到[注册表(Registry)](/ecosystem)
542+
* 提交[博客文章或案例研究](/docs/contributing/blog/)
564543

565544
[仪表板]: https://app.netlify.com/sites/opentelemetry/overview
566545

0 commit comments

Comments
 (0)