@@ -138,7 +138,7 @@ When closing a PR, convey an explanatory and cordial message explaining
138
138
why it does not meet the requirements to be merged.
139
139
140
140
🙂 “I’m closing this PR because this feature can’t support the use case X. In
141
- it's proposed form, it would be a better to be implemented with Y tool. Thank
141
+ its proposed form, it would be better to implement with Y tool. Thank
142
142
you for working on this.”
143
143
144
144
😞 “Why isn’t this following the API conventions? This should be done elsewhere!”
@@ -151,7 +151,7 @@ why it does not meet the requirements to be merged.
151
151
152
152
Before you can submit a contribution, you must [ sign the Contributor License
153
153
Agreement(CLA)] [ cla ] . The Kubernetes project can _ only_ accept a contribution
154
- if you or your company has signed the CLA.
154
+ if you or your company have signed the CLA.
155
155
156
156
Should you encounter any problems signing the CLA, follow the [ CLA
157
157
troubleshooting guidelines] .
@@ -162,7 +162,7 @@ troubleshooting guidelines].
162
162
GitHub Issues are the primary means of tracking things such as bug reports,
163
163
enhancement requests, or reporting other issues such as failing tests. They are
164
164
** not** intended for [ user support requests] . For those, please check with the
165
- [ troubleshooting guide] , report the problem to [ Stack Overflow] or follow up on
165
+ [ troubleshooting guide] , report the problem to [ Stack Overflow] , or follow up on
166
166
the [ Kubernetes forum] .
167
167
168
168
** References:**
@@ -210,8 +210,8 @@ other forms of work that would be stored within a git repository.
210
210
#### Creating a Pull Request
211
211
212
212
- Follow the directions of the pull request template if one is available. It
213
- will help those that respond to your PR.
214
- - If a [ trivial fix] such as a broken link, typo or grammar mistake, review the
213
+ will help those who respond to your PR.
214
+ - If a [ trivial fix] such as a broken link, typo, or grammar mistake, review the
215
215
entire document for other potential mistakes. Do not open multiple PRs for
216
216
small fixes in the same document.
217
217
- Reference any issues related to your PR, or issues that PR may solve.
@@ -248,11 +248,11 @@ What's in that PR:
248
248
- ** Line 1** - Reference to other issues or PRs (#3064 #3097 ).
249
249
- ** Line 2** - A brief description of what is being done in the PR.
250
250
- ** Line 4** - [ SIG] [ sigs ] assignment with the [ command] [ commands ]
251
- ` /sig contributor-experience ` ..
252
- - ** Line 5** - Reviewers that may have interest on this specific issue or PR are
251
+ ` /sig contributor-experience ` .
252
+ - ** Line 5** - Reviewers that may have interest in this specific issue or PR are
253
253
specified with the [ ` /cc ` ] [ cc ] command.
254
- - ** Line 6** - The [ ` /kind cleanup ` ] [ kind ] command add a [ label] [ labels ] that
255
- categorizes issue or PR as related to cleaning up code, process, or technical
254
+ - ** Line 6** - The [ ` /kind cleanup ` ] [ kind ] command adds a [ label] [ labels ] that
255
+ categorizes issues or PR as related to cleaning up code, process, or technical
256
256
debt.
257
257
- ** Line 7** - The [ ` /area developer-guide ` ] [ kind ] command categorizes issue or
258
258
PR as related to the developer guide.
@@ -270,7 +270,7 @@ will reply to the PR with links to the failed tests and available logs.
270
270
271
271
Pushing new commits to your PR will automatically trigger the tests to re-run.
272
272
273
- Occasionally there can be issues with Kubernetes CI platform. These can occur
273
+ Occasionally there can be issues with the Kubernetes CI platform. These can occur
274
274
for a wide variety of reasons even if your contribution passes all local
275
275
tests. You can trigger a re-run of the tests with the ` /retest ` command.
276
276
@@ -325,7 +325,7 @@ configured within your local working copy.
325
325
Add ` upstream ` as a remote, and configure it so you cannot push to it.
326
326
327
327
```
328
- # replace <upstream git repo> with the upstream repo url
328
+ # replace <upstream git repo> with the upstream repo URL
329
329
# example:
330
330
# https://github.com/kubernetes/kubernetes.git
331
331
# [email protected] /kubernetes/kubernetes.git
@@ -360,9 +360,9 @@ git checkout -b myfeature
360
360
#### Squashing Commits
361
361
362
362
The main purpose of [ squashing commits] is to create a clean readable git
363
- history or log of the changes that were made. Usually this is done in last
363
+ history or log of the changes that were made. Usually, this is done in the last
364
364
phase of a PR revision. If you are unsure if you should squash your commits, it
365
- is better to err on the side of having more and leave it up to the judgement of
365
+ is better to err on the side of having more and leave it up to the judgment of
366
366
the other contributors assigned to review and approve your PR.
367
367
368
368
Perform an interactive rebase to choose which commits you want to keep and which you want to squash, then force push your branch:
0 commit comments