@@ -78,8 +78,6 @@ better.
78
78
79
79
### Workflow
80
80
81
- - [ Gubernator Dashboard] - View incoming and outgoing Pull Requests that require
82
- your attention.
83
81
- [ Prow] - Kubernetes CI/CD System.
84
82
- [ Tide] - Prow plugin that manages merges and tests. [ Tide Dashboard]
85
83
- [ Bot commands] - Commands used to interact with Kubernetes Bots (examples:
@@ -140,7 +138,7 @@ When closing a PR, convey an explanatory and cordial message explaining
140
138
why it does not meet the requirements to be merged.
141
139
142
140
🙂 “I’m closing this PR because this feature can’t support the use case X. In
143
- 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
144
142
you for working on this.”
145
143
146
144
😞 “Why isn’t this following the API conventions? This should be done elsewhere!”
@@ -153,7 +151,7 @@ why it does not meet the requirements to be merged.
153
151
154
152
Before you can submit a contribution, you must [ sign the Contributor License
155
153
Agreement(CLA)] [ cla ] . The Kubernetes project can _ only_ accept a contribution
156
- if you or your company has signed the CLA.
154
+ if you or your company have signed the CLA.
157
155
158
156
Should you encounter any problems signing the CLA, follow the [ CLA
159
157
troubleshooting guidelines] .
@@ -164,7 +162,7 @@ troubleshooting guidelines].
164
162
GitHub Issues are the primary means of tracking things such as bug reports,
165
163
enhancement requests, or reporting other issues such as failing tests. They are
166
164
** not** intended for [ user support requests] . For those, please check with the
167
- [ 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
168
166
the [ Kubernetes forum] .
169
167
170
168
** References:**
@@ -212,8 +210,8 @@ other forms of work that would be stored within a git repository.
212
210
#### Creating a Pull Request
213
211
214
212
- Follow the directions of the pull request template if one is available. It
215
- will help those that respond to your PR.
216
- - 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
217
215
entire document for other potential mistakes. Do not open multiple PRs for
218
216
small fixes in the same document.
219
217
- Reference any issues related to your PR, or issues that PR may solve.
@@ -250,11 +248,11 @@ What's in that PR:
250
248
- ** Line 1** - Reference to other issues or PRs (#3064 #3097 ).
251
249
- ** Line 2** - A brief description of what is being done in the PR.
252
250
- ** Line 4** - [ SIG] [ sigs ] assignment with the [ command] [ commands ]
253
- ` /sig contributor-experience ` ..
254
- - ** 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
255
253
specified with the [ ` /cc ` ] [ cc ] command.
256
- - ** Line 6** - The [ ` /kind cleanup ` ] [ kind ] command add a [ label] [ labels ] that
257
- 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
258
256
debt.
259
257
- ** Line 7** - The [ ` /area developer-guide ` ] [ kind ] command categorizes issue or
260
258
PR as related to the developer guide.
@@ -272,7 +270,7 @@ will reply to the PR with links to the failed tests and available logs.
272
270
273
271
Pushing new commits to your PR will automatically trigger the tests to re-run.
274
272
275
- 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
276
274
for a wide variety of reasons even if your contribution passes all local
277
275
tests. You can trigger a re-run of the tests with the ` /retest ` command.
278
276
@@ -327,7 +325,7 @@ configured within your local working copy.
327
325
Add ` upstream ` as a remote, and configure it so you cannot push to it.
328
326
329
327
```
330
- # replace <upstream git repo> with the upstream repo url
328
+ # replace <upstream git repo> with the upstream repo URL
331
329
# example:
332
330
# https://github.com/kubernetes/kubernetes.git
333
331
# [email protected] /kubernetes/kubernetes.git
@@ -362,9 +360,9 @@ git checkout -b myfeature
362
360
#### Squashing Commits
363
361
364
362
The main purpose of [ squashing commits] is to create a clean readable git
365
- 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
366
364
phase of a PR revision. If you are unsure if you should squash your commits, it
367
- 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
368
366
the other contributors assigned to review and approve your PR.
369
367
370
368
Perform an interactive rebase to choose which commits you want to keep and which you want to squash, then force push your branch:
@@ -380,7 +378,6 @@ git push --force
380
378
[ contributor course ] : https://www.kubernetes.dev/docs/onboarding
381
379
[ contributor guide ] : /contributors/guide/README.md
382
380
[ developer guide ] : /contributors/devel/README.md
383
- [ gubernator dashboard ] : https://gubernator.k8s.io/pr
384
381
[ prow ] : https://prow.k8s.io
385
382
[ tide ] : http://git.k8s.io/test-infra/prow/cmd/tide/pr-authors.md
386
383
[ tide dashboard ] : https://prow.k8s.io/tide
0 commit comments