@@ -14,7 +14,7 @@ project, or the project as a whole. We follow a similar set of
14
14
definitions to the [ main Kubernetes project itself] [ kube-ladder ] , with
15
15
slightly looser requirements.
16
16
17
- As much as possible, we want people to help take on responsibility in the
17
+ As much as possible, we want people to help take on responsibility for the
18
18
project -- these guidelines are attempts to make it * easier* for this to
19
19
happen, * not harder* . If you've got any questions, just reach out on
20
20
Slack to one of the [ subproject leads] [ kb-leads ] (called
@@ -24,7 +24,7 @@ kubebuilder-admins in the `OWNERS_ALIASES` file).
24
24
25
25
Anyone who wants to become a reviewer or approver must first be a [ member
26
26
of the Kubernetes project] [ kube-member ] . The aforementioned doc has more
27
- details, but the gist is that you must have made a couple contributions to
27
+ details, but the gist is that you must have made a couple of contributions to
28
28
some part of the Kubernetes project -- * this includes Kubebuilder and
29
29
related repos* . Then, you need two existing members to sponsor you.
30
30
@@ -34,22 +34,22 @@ sponsor you, just ping us on Slack :-)**
34
34
## Reviewers
35
35
36
36
Reviewers are recognized as able to provide code reviews for parts of the
37
- codebase, and are entered into the ` reviewers ` section of one or more
37
+ codebase and are entered into the ` reviewers ` section of one or more
38
38
` OWNERS ` files. You'll get auto-assigned reviews for your area of the
39
- codebase, and are generally expected to review for both correctness,
39
+ codebase and are generally expected to review for correctness,
40
40
testing, general code organization, etc. Reviewers may review for design
41
41
as well, but approvers have the final say on that.
42
42
43
43
Things to look for:
44
44
45
- - does this code work, and is it written performantly and idomatically ?
45
+ - does this code work, and is it written performantly and idiomatically ?
46
46
- is it tested?
47
47
- is it organized nicely? Is it maintainable?
48
48
- is it documented?
49
49
- does it need to be threadsafe? Is it?
50
50
- Take a glance at the stuff for approvers, if you can.
51
51
52
- Reviewers' ` /lgtm ` marks are generally trusted by approvers to mean that
52
+ Reviewers' ` /lgtm ` marks are generally trusted by approvers to means that
53
53
the code is ready for one last look-over before merging.
54
54
55
55
### Becoming a Reviewer
@@ -65,7 +65,7 @@ worked on a cross-cutting feature, it's ok to count PRs across
65
65
repositories.
66
66
67
67
Once you meet those criteria, submit yourself as a reviewer in the
68
- ` OWNERS ` file or files that you feel represent your areas of knowlege via
68
+ ` OWNERS ` file or files that you feel represent your areas of knowledge via
69
69
a PR to the relevant repository.
70
70
71
71
## Approvers
@@ -75,14 +75,14 @@ Once approvals (`/approve`) are given for each piece of the affected code
75
75
(and a reviewer or approver has added ` /lgtm ` ), the code will merge.
76
76
77
77
Approvers are responsible for giving the code a final once-over before
78
- merge, and doing an overall design/API review.
78
+ merge, and do an overall design/API review.
79
79
80
80
Things to look for:
81
81
82
82
- Does the API exposed to the user make sense, and is it easy to use?
83
- - Is it backwards compatible?
83
+ - Is it backward compatible?
84
84
- Will it accommodate new changes in the future?
85
- - Is it extesnible/layerable (see [ DESIGN.md] ( ../DESIGN.md ) )?
85
+ - Is it extensible/layer-able (see [ DESIGN.md] ( ../DESIGN.md ) )?
86
86
- Does it expose a new type from ` k8s.io/XYZ ` , and, if so, is it worth it?
87
87
Is that piece well-designed?
88
88
@@ -93,24 +93,24 @@ them.
93
93
94
94
### Becoming an Approver
95
95
96
- All approvers need to start out as reviewers. The criteria for becoming
97
- an approver are :
96
+ All approvers need to start as reviewers. The criteria for becoming
97
+ an approver is :
98
98
99
- - Be a reviewer in the area for a couple months
99
+ - Be a reviewer in the area for a couple of months
100
100
- Be the "main" reviewer or contributor for 5-10 substantial (bugfixes,
101
101
features, etc) PRs where approvers did not need to leave substantial
102
102
additional comments (i.e. where you were acting as a defacto approver).
103
103
104
104
Once you've met those criteria, you can submit yourself as an approver
105
- using a PR that edits the revelant ` OWNERS ` files appropriately. The
105
+ using a PR that edits the relevant ` OWNERS ` files appropriately. The
106
106
existing approvers will then approve the change with lazy consensus. If
107
107
you feel more comfortable asking before submitting the PR, feel free to
108
108
ping one of the [ subproject leads] [ kb-leads ] (called kubebuilder-admins in
109
109
the ` OWNERS_ALIASES ` file) on Slack.
110
110
111
111
## Indirectly Code-Related/Non-Code Roles
112
112
113
- We're always looking help with other areas of the project as well, such
113
+ We're always looking for help with other areas of the project as well, such
114
114
as:
115
115
116
116
### Docs
@@ -120,15 +120,15 @@ reviewers/approvers for the book by following the same process above.
120
120
121
121
### Triage
122
122
123
- Help triaging our issues is also welcome. Folks doing triage are
123
+ Help to triage our issues is also welcome. Folks doing triage are
124
124
responsible for using the following commands to mark PRs and issues with
125
125
one or more labels, and should also feel free to help answer questions:
126
126
127
127
- ` /kind {bug|feature|documentation} ` : things that are broken/new
128
- things/things with lots of words, repsectively
128
+ things/things with lots of words, respectively
129
129
130
130
- ` /triage support ` : questions, and things that might be bugs but might
131
- just be confusion of how to use something
131
+ just be confused about how to use something
132
132
133
133
- ` /priority {backlog|important-longterm|important-soon|critical-urgent} ` :
134
134
how soon we need to deal with the thing (if someone wants
0 commit comments