Skip to content

Commit 9cf3615

Browse files
authored
Merge pull request #4605 from chethanm99/chethanm99-branch-1
📖 Update CONTRIBUTING-ROLES.md with minor changes
2 parents 33675ce + 0074421 commit 9cf3615

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

docs/CONTRIBUTING-ROLES.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ project, or the project as a whole. We follow a similar set of
1414
definitions to the [main Kubernetes project itself][kube-ladder], with
1515
slightly looser requirements.
1616

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
1818
project -- these guidelines are attempts to make it *easier* for this to
1919
happen, *not harder*. If you've got any questions, just reach out on
2020
Slack to one of the [subproject leads][kb-leads] (called
@@ -24,7 +24,7 @@ kubebuilder-admins in the `OWNERS_ALIASES` file).
2424

2525
Anyone who wants to become a reviewer or approver must first be a [member
2626
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
2828
some part of the Kubernetes project -- *this includes Kubebuilder and
2929
related repos*. Then, you need two existing members to sponsor you.
3030

@@ -34,22 +34,22 @@ sponsor you, just ping us on Slack :-)**
3434
## Reviewers
3535

3636
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
3838
`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,
4040
testing, general code organization, etc. Reviewers may review for design
4141
as well, but approvers have the final say on that.
4242

4343
Things to look for:
4444

45-
- does this code work, and is it written performantly and idomatically?
45+
- does this code work, and is it written performantly and idiomatically?
4646
- is it tested?
4747
- is it organized nicely? Is it maintainable?
4848
- is it documented?
4949
- does it need to be threadsafe? Is it?
5050
- Take a glance at the stuff for approvers, if you can.
5151

52-
Reviewers' `/lgtm` marks are generally trusted by approvers to mean that
52+
Reviewers' `/lgtm` marks are generally trusted by approvers to means that
5353
the code is ready for one last look-over before merging.
5454

5555
### Becoming a Reviewer
@@ -65,7 +65,7 @@ worked on a cross-cutting feature, it's ok to count PRs across
6565
repositories.
6666

6767
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
6969
a PR to the relevant repository.
7070

7171
## Approvers
@@ -75,14 +75,14 @@ Once approvals (`/approve`) are given for each piece of the affected code
7575
(and a reviewer or approver has added `/lgtm`), the code will merge.
7676

7777
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.
7979

8080
Things to look for:
8181

8282
- 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?
8484
- 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))?
8686
- Does it expose a new type from `k8s.io/XYZ`, and, if so, is it worth it?
8787
Is that piece well-designed?
8888

@@ -93,24 +93,24 @@ them.
9393

9494
### Becoming an Approver
9595

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:
9898

99-
- Be a reviewer in the area for a couple months
99+
- Be a reviewer in the area for a couple of months
100100
- Be the "main" reviewer or contributor for 5-10 substantial (bugfixes,
101101
features, etc) PRs where approvers did not need to leave substantial
102102
additional comments (i.e. where you were acting as a defacto approver).
103103

104104
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
106106
existing approvers will then approve the change with lazy consensus. If
107107
you feel more comfortable asking before submitting the PR, feel free to
108108
ping one of the [subproject leads][kb-leads] (called kubebuilder-admins in
109109
the `OWNERS_ALIASES` file) on Slack.
110110

111111
## Indirectly Code-Related/Non-Code Roles
112112

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
114114
as:
115115

116116
### Docs
@@ -120,15 +120,15 @@ reviewers/approvers for the book by following the same process above.
120120

121121
### Triage
122122

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
124124
responsible for using the following commands to mark PRs and issues with
125125
one or more labels, and should also feel free to help answer questions:
126126

127127
- `/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
129129

130130
- `/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
132132

133133
- `/priority {backlog|important-longterm|important-soon|critical-urgent}`:
134134
how soon we need to deal with the thing (if someone wants

0 commit comments

Comments
 (0)