Skip to content

Commit 4ac39b1

Browse files
authored
Merge pull request #7567 from juliafmorgado/readme
Remove Gubernator reference from README.md (deprecated) and fix grammar
2 parents 02a85ec + 864bc2c commit 4ac39b1

File tree

1 file changed

+13
-16
lines changed
  • contributors/guide/contributor-cheatsheet

1 file changed

+13
-16
lines changed

contributors/guide/contributor-cheatsheet/README.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,6 @@ better.
7878

7979
### Workflow
8080

81-
- [Gubernator Dashboard] - View incoming and outgoing Pull Requests that require
82-
your attention.
8381
- [Prow] - Kubernetes CI/CD System.
8482
- [Tide] - Prow plugin that manages merges and tests. [Tide Dashboard]
8583
- [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
140138
why it does not meet the requirements to be merged.
141139

142140
🙂 “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
144142
you for working on this.”
145143

146144
😞 “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.
153151

154152
Before you can submit a contribution, you must [sign the Contributor License
155153
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.
157155

158156
Should you encounter any problems signing the CLA, follow the [CLA
159157
troubleshooting guidelines].
@@ -164,7 +162,7 @@ troubleshooting guidelines].
164162
GitHub Issues are the primary means of tracking things such as bug reports,
165163
enhancement requests, or reporting other issues such as failing tests. They are
166164
**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
168166
the [Kubernetes forum].
169167

170168
**References:**
@@ -212,8 +210,8 @@ other forms of work that would be stored within a git repository.
212210
#### Creating a Pull Request
213211

214212
- 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
217215
entire document for other potential mistakes. Do not open multiple PRs for
218216
small fixes in the same document.
219217
- Reference any issues related to your PR, or issues that PR may solve.
@@ -250,11 +248,11 @@ What's in that PR:
250248
- **Line 1** - Reference to other issues or PRs (#3064 #3097).
251249
- **Line 2** - A brief description of what is being done in the PR.
252250
- **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
255253
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
258256
debt.
259257
- **Line 7** - The [`/area developer-guide`][kind] command categorizes issue or
260258
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.
272270

273271
Pushing new commits to your PR will automatically trigger the tests to re-run.
274272

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
276274
for a wide variety of reasons even if your contribution passes all local
277275
tests. You can trigger a re-run of the tests with the `/retest` command.
278276

@@ -327,7 +325,7 @@ configured within your local working copy.
327325
Add `upstream` as a remote, and configure it so you cannot push to it.
328326

329327
```
330-
# replace <upstream git repo> with the upstream repo url
328+
# replace <upstream git repo> with the upstream repo URL
331329
# example:
332330
# https://github.com/kubernetes/kubernetes.git
333331
# [email protected]/kubernetes/kubernetes.git
@@ -362,9 +360,9 @@ git checkout -b myfeature
362360
#### Squashing Commits
363361

364362
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
366364
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
368366
the other contributors assigned to review and approve your PR.
369367

370368
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
380378
[contributor course]: https://www.kubernetes.dev/docs/onboarding
381379
[contributor guide]: /contributors/guide/README.md
382380
[developer guide]: /contributors/devel/README.md
383-
[gubernator dashboard]: https://gubernator.k8s.io/pr
384381
[prow]: https://prow.k8s.io
385382
[tide]: http://git.k8s.io/test-infra/prow/cmd/tide/pr-authors.md
386383
[tide dashboard]: https://prow.k8s.io/tide

0 commit comments

Comments
 (0)