@@ -10,9 +10,8 @@ weight: 10
10
10
Anyone can review a documentation pull request. Visit the [ pull requests] ( https://github.com/kubernetes/website/pulls )
11
11
section in the Kubernetes website repository to see open pull requests.
12
12
13
- Reviewing documentation pull requests is a
14
- great way to introduce yourself to the Kubernetes community.
15
- It helps you learn the code base and build trust with other contributors.
13
+ Reviewing documentation pull requests is a great way to introduce yourself to the Kubernetes
14
+ community. It helps you learn the code base and build trust with other contributors.
16
15
17
16
Before reviewing, it's a good idea to:
18
17
@@ -28,7 +27,6 @@ Before reviewing, it's a good idea to:
28
27
29
28
Before you start a review:
30
29
31
-
32
30
- Read the [ CNCF Code of Conduct] ( https://github.com/cncf/foundation/blob/main/code-of-conduct.md )
33
31
and ensure that you abide by it at all times.
34
32
- Be polite, considerate, and helpful.
@@ -73,6 +71,7 @@ class third,fourth white
73
71
74
72
Figure 1. Review process steps.
75
73
74
+
76
75
1 . Go to [ https://github.com/kubernetes/website/pulls ] ( https://github.com/kubernetes/website/pulls ) .
77
76
You see a list of every open pull request against the Kubernetes website and docs.
78
77
@@ -103,12 +102,20 @@ Figure 1. Review process steps.
103
102
4 . Go to the ** Files changed** tab to start your review.
104
103
105
104
1 . Click on the ` + ` symbol beside the line you want to comment on.
106
- 1 . Fill in any comments you have about the line and click either ** Add single comment** (if you
107
- have only one comment to make) or ** Start a review** (if you have multiple comments to make).
105
+ 1 . Fill in any comments you have about the line and click either ** Add single comment**
106
+ (if you have only one comment to make) or ** Start a review** (if you have multiple comments to make).
108
107
1 . When finished, click ** Review changes** at the top of the page. Here, you can add
109
- a summary of your review (and leave some positive comments for the contributor!),
110
- approve the PR, comment or request changes as needed. New contributors should always
111
- choose ** Comment** .
108
+ a summary of your review (and leave some positive comments for the contributor!).
109
+ Please always use the "Comment"
110
+
111
+ - Avoid clicking the "Request changes" button when finishing your review.
112
+ If you want to block a PR from being merged before some further changes are made,
113
+ you can leave a "/hold" comment.
114
+ Mention why you are setting a hold, and optionally specify the conditions under
115
+ which the hold can be removed by you or other reviewers.
116
+
117
+ - Avoid clicking the "Approve" button when finishing your review.
118
+ Leaving a "/approve" comment is recommended most of the time.
112
119
113
120
## Reviewing checklist
114
121
0 commit comments