You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
SIG Docs [Reviewers](/docs/contribute/participate/#reviewers) and [Approvers](/docs/contribute/participate/#approvers) do a few extra things when reviewing a change.
18
+
SIG Docs [Reviewers](/docs/contribute/participate/#reviewers) and
19
+
[Approvers](/docs/contribute/participate/#approvers) do a few extra things
20
+
when reviewing a change.
19
21
20
-
Every week a specific docs approver volunteers to triage
21
-
and review pull requests. This
22
-
person is the "PR Wrangler" for the week. See the
23
-
[PR Wrangler scheduler](https://github.com/kubernetes/website/wiki/PR-Wranglers) for more information. To become a PR Wrangler, attend the weekly SIG Docs meeting and volunteer. Even if you are not on the schedule for the current week, you can still review pull
24
-
requests (PRs) that are not already under active review.
22
+
Every week a specific docs approver volunteers to triage and review pull requests.
23
+
This person is the "PR Wrangler" for the week. See the
for more information. To become a PR Wrangler, attend the weekly SIG Docs meeting
26
+
and volunteer. Even if you are not on the schedule for the current week, you can
27
+
still review pull requests (PRs) that are not already under active review.
25
28
26
29
In addition to the rotation, a bot assigns reviewers and approvers
27
30
for the PR based on the owners for the affected files.
@@ -43,9 +46,12 @@ SIG Docs
43
46
<!-- body -->
44
47
<!--
45
48
## Reviewing a PR
46
-
Kubernetes documentation follows the [Kubernetes code review process](https://github.com/kubernetes/community/blob/master/contributors/guide/owners.md#the-code-review-process).
47
49
48
-
Everything described in [Reviewing a pull request](/docs/contribute/review/reviewing-prs) applies, but Reviewers and Approvers should also do the following:
- Using the `/assign` Prow command to assign a specific reviewer to a PR as needed. This is extra important
59
-
when it comes to requesting technical review from code contributors.
64
+
- Using the `/assign` Prow command to assign a specific reviewer to a PR as needed.
65
+
This is extra important when it comes to requesting technical review from code contributors.
60
66
61
67
{{< note >}}
62
68
Look at the `reviewers` field in the front-matter at the top of a Markdown file to see who can
63
69
provide technical review.
64
70
{{< /note >}}
65
71
66
-
- Making sure the PR follows the [Content](/docs/contribute/style/content-guide/) and [Style](/docs/contribute/style/style-guide/) guides; link the author to the relevant part of the guide(s) if it doesn't.
72
+
- Making sure the PR follows the [Content](/docs/contribute/style/content-guide/)
73
+
and [Style](/docs/contribute/style/style-guide/) guides; link the author to the
74
+
relevant part of the guide(s) if it doesn't.
67
75
- Using the GitHub **Request Changes** option when applicable to suggest changes to the PR author.
68
-
- Changing your review status in GitHub using the `/approve` or `/lgtm` Prow commands, if your suggestions are implemented.
76
+
- Changing your review status in GitHub using the `/approve` or `/lgtm` Prow commands,
77
+
if your suggestions are implemented.
69
78
-->
70
79
- 根据需要使用 Prow 命令 `/assign` 指派特定的评阅人。如果某个 PR
71
80
需要来自代码贡献者的技术审核时，这一点非常重要。
@@ -108,13 +117,6 @@ true:
108
117
- If the PR author pushed their branch directly to the
repository. Only a reviewer with push access can commit to another user's PR.
111
-
112
-
{{< note >}}
113
-
Encourage the author to push their branch to their fork before
114
-
opening the PR next time.
115
-
{{< /note >}}
116
-
117
-
- The PR author explicitly disallows edits from approvers.
118
120
-->
119
121
如果处于下列情况之一，你不可以向别人的 PR 提交内容：
120
122
@@ -123,9 +125,16 @@ true:
123
125
仓库。只有具有推送权限的评阅人才可以向他人的 PR 提交内容。
124
126
125
127
{{< note >}}
128
+
<!--
129
+
Encourage the author to push their branch to their fork before
130
+
opening the PR next time.
131
+
-->
126
132
我们应鼓励作者下次将分支推送到自己的克隆副本之后再发起 PR。
127
133
{{< /note >}}
128
134
135
+
<!--
136
+
- The PR author explicitly disallows edits from approvers.
137
+
-->
129
138
- PR 作者明确地禁止批准人编辑他/她的 PR。
130
139
131
140
<!--
@@ -134,7 +143,9 @@ true:
134
143
[Prow](https://github.com/kubernetes/test-infra/blob/master/prow/README.md) is
135
144
the Kubernetes-based CI/CD system that runs jobs against pull requests (PRs). Prow
136
145
enables chatbot-style commands to handle GitHub actions across the Kubernetes
137
-
organization, like [adding and removing labels](#adding-and-removing-issue-labels), closing issues, and assigning an approver. Enter Prow commands as GitHub comments using the `/<command-name>` format.
146
+
organization, like [adding and removing labels](#adding-and-removing-issue-labels),
147
+
closing issues, and assigning an approver. Enter Prow commands as GitHub comments
148
+
using the `/<command-name>` format.
138
149
139
150
The most common prow commands reviewers and approvers use are:
In general, SIG Docs follows the [Kubernetes issue triage](https://github.com/kubernetes/community/blob/master/contributors/guide/issue-triage.md) process and uses the same labels.
This GitHub Issue [filter](https://github.com/kubernetes/website/issues?q=is%3Aissue+is%3Aopen+-label%3Apriority%2Fbacklog+-label%3Apriority%2Fimportant-longterm+-label%3Apriority%2Fimportant-soon+-label%3Atriage%2Fneeds-information+-label%3Atriage%2Fsupport+sort%3Acreated-asc)
186
200
finds issues that might need triage.
@@ -197,13 +211,14 @@ finds issues that might need triage.
197
211
### Triaging an issue
198
212
199
213
1. Validate the issue
200
-
- Make sure the issue is about website documentation. Some issues can be closed quickly by
201
-
answering a question or pointing the reporter to a resource. See the
202
-
[Support requests or code bug reports](#support-requests-or-code-bug-reports) section for details.
203
-
- Assess whether the issue has merit.
204
-
- Add the `triage/needs-information` label if the issue doesn't have enough
205
-
detail to be actionable or the template is not filled out adequately.
206
-
- Close the issue if it has both the `lifecycle/stale` and `triage/needs-information` labels.
214
+
215
+
- Make sure the issue is about website documentation. Some issues can be closed quickly by
216
+
answering a question or pointing the reporter to a resource. See the
217
+
[Support requests or code bug reports](#support-requests-or-code-bug-reports) section for details.
218
+
- Assess whether the issue has merit.
219
+
- Add the `triage/needs-information` label if the issue doesn't have enough
220
+
detail to be actionable or the template is not filled out adequately.
221
+
- Close the issue if it has both the `lifecycle/stale` and `triage/needs-information` labels.
207
222
-->
208
223
209
224
### 评判 Issue {#triaging-an-issue}
@@ -222,9 +237,10 @@ finds issues that might need triage.
222
237
223
238
<!--
224
239
2. Add a priority label (the
225
-
[Issue Triage Guidelines](https://github.com/kubernetes/community/blob/master/contributors/guide/issue-triage.md#define-priority) define priority labels in detail)
@@ -234,6 +250,8 @@ finds issues that might need triage.
234
250
`priority/awaiting-more-evidence` | Placeholder for a potentially good issue so it doesn't get lost.
235
251
`help` or `good first issue` | Suitable for someone with very little Kubernetes or SIG Docs experience. See [Help Wanted and Good First Issue Labels](https://kubernetes.dev/docs/guide/help-wanted/) for more information.
236
252
253
+
{{< /table >}}
254
+
237
255
At your discretion, take ownership of an issue and submit a PR for it
238
256
(especially if it's quick or relates to work you're already doing).
239
257
@@ -290,7 +308,8 @@ To remove a label, leave a comment in one of the following formats:
290
308
In both cases, the label must already exist. If you try to add a label that does not exist, the command is
291
309
silently ignored.
292
310
293
-
For a list of all labels, see the [website repository's Labels section](https://github.com/kubernetes/website/labels). Not all labels are used by SIG Docs.
311
+
For a list of all labels, see the [website repository's Labels section](https://github.com/kubernetes/website/labels).
312
+
Not all labels are used by SIG Docs.
294
313
-->
295
314
在以上两种情况下，标签都必须合法存在。如果你尝试添加一个尚不存在的标签，
296
315
对应的命令会被悄悄忽略。
@@ -356,7 +375,9 @@ SIG Docs 常常会遇到以下类型的 Issue，因此对其处理方式描述
356
375
<!--
357
376
### Dead link issues
358
377
359
-
If the dead link issue is in the API or `kubectl` documentation, assign them `/priority critical-urgent` until the problem is fully understood. Assign all other dead link issues `/priority important-longterm`, as they must be manually fixed.
378
+
If the dead link issue is in the API or `kubectl` documentation, assign them
379
+
`/priority critical-urgent` until the problem is fully understood. Assign all
380
+
other dead link issues `/priority important-longterm`, as they must be manually fixed.
**Squashing commits for contributors**: If a contributor might have difficulty
493
+
squashing commits or there is time pressure to merge a PR, you can perform the
494
+
squash for them:
495
+
-->
496
+
**协助贡献者压缩提交**：如果贡献者压缩提交遇到难题或合并 PR 的时间紧迫，
497
+
你可以协助贡献者执行压缩提交的操作。
498
+
499
+
<!--
500
+
- The kubernetes/website repo is
501
+
[configured to allow squashing for pull request merges](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests).
502
+
Simply select the *Squash commits* button.
503
+
- In the PR, if the contributor enables maintainers to manage the PR, you can
504
+
squash their commits and update their fork with the result. Before you squash,
505
+
advise them to save and push their latest changes to the PR. After you squash,
506
+
advise them to pull the squashed commit to their local clone.
507
+
- You can get GitHub to squash the commits by using a label so that Tide / GitHub
508
+
performs the squash or by clicking the *Squash commits* button when you merge the PR.
0 commit comments