kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #7567 from juliafmorgado/readme 

Remove Gubernator reference from README.md (deprecated) and fix grammar
This commit is contained in:
Kubernetes Prow Robot 2023-10-05 00:59:59 +02:00 committed by GitHub
parent 02a85eca5a 864bc2c60a
commit 4ac39b1716
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
contributors/guide/contributor-cheatsheet/README.md
View File

@ -78,8 +78,6 @@ better.
### Workflow
- [Gubernator Dashboard] - View incoming and outgoing Pull Requests that require
your attention.
- [Prow] - Kubernetes CI/CD System.
- [Tide] - Prow plugin that manages merges and tests. [Tide Dashboard]
- [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
why it does not meet the requirements to be merged.
🙂 “I’m closing this PR because this feature can’t support the use case X. In
it's proposed form, it would be a better to be implemented with Y tool. Thank
its proposed form, it would be better to implement with Y tool. Thank
you for working on this.”
😞 “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.
Before you can submit a contribution, you must [sign the Contributor License
Agreement(CLA)][cla]. The Kubernetes project can _only_ accept a contribution
if you or your company has signed the CLA.
if you or your company have signed the CLA.
Should you encounter any problems signing the CLA, follow the [CLA
troubleshooting guidelines].
@ -164,7 +162,7 @@ troubleshooting guidelines].
GitHub Issues are the primary means of tracking things such as bug reports,
enhancement requests, or reporting other issues such as failing tests. They are
**not** intended for [user support requests]. For those, please check with the
[troubleshooting guide], report the problem to [Stack Overflow] or follow up on
[troubleshooting guide], report the problem to [Stack Overflow], or follow up on
the [Kubernetes forum].
**References:**
@ -212,8 +210,8 @@ other forms of work that would be stored within a git repository.
#### Creating a Pull Request
- Follow the directions of the pull request template if one is available. It
will help those that respond to your PR.
- If a [trivial fix] such as a broken link, typo or grammar mistake, review the
will help those who respond to your PR.
- If a [trivial fix] such as a broken link, typo, or grammar mistake, review the
entire document for other potential mistakes. Do not open multiple PRs for
small fixes in the same document.
- Reference any issues related to your PR, or issues that PR may solve.
@ -250,11 +248,11 @@ What's in that PR:
- **Line 1** - Reference to other issues or PRs (#3064 #3097).
- **Line 2** - A brief description of what is being done in the PR.
- **Line 4** - [SIG][sigs] assignment with the [command][commands]
`/sig contributor-experience`..
- **Line 5** - Reviewers that may have interest on this specific issue or PR are
`/sig contributor-experience`.
- **Line 5** - Reviewers that may have interest in this specific issue or PR are
specified with the [`/cc`][cc] command.
- **Line 6** - The [`/kind cleanup`][kind] command add a [label][labels] that
categorizes issue or PR as related to cleaning up code, process, or technical
- **Line 6** - The [`/kind cleanup`][kind] command adds a [label][labels] that
categorizes issues or PR as related to cleaning up code, process, or technical
debt.
- **Line 7** - The [`/area developer-guide`][kind] command categorizes issue or
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.
Pushing new commits to your PR will automatically trigger the tests to re-run.
Occasionally there can be issues with Kubernetes CI platform. These can occur
Occasionally there can be issues with the Kubernetes CI platform. These can occur
for a wide variety of reasons even if your contribution passes all local
tests. You can trigger a re-run of the tests with the `/retest` command.
@ -327,7 +325,7 @@ configured within your local working copy.
Add `upstream` as a remote, and configure it so you cannot push to it.
```
# replace <upstream git repo> with the upstream repo url
# replace <upstream git repo> with the upstream repo URL
# example:
# https://github.com/kubernetes/kubernetes.git
# git@github.com/kubernetes/kubernetes.git
@ -362,9 +360,9 @@ git checkout -b myfeature
#### Squashing Commits
The main purpose of [squashing commits] is to create a clean readable git
history or log of the changes that were made. Usually this is done in last
history or log of the changes that were made. Usually, this is done in the last
phase of a PR revision. If you are unsure if you should squash your commits, it
is better to err on the side of having more and leave it up to the judgement of
is better to err on the side of having more and leave it up to the judgment of
the other contributors assigned to review and approve your PR.
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
[contributor course]: https://www.kubernetes.dev/docs/onboarding
[contributor guide]: /contributors/guide/README.md
[developer guide]: /contributors/devel/README.md
[gubernator dashboard]: https://gubernator.k8s.io/pr
[prow]: https://prow.k8s.io
[tide]: http://git.k8s.io/test-infra/prow/cmd/tide/pr-authors.md
[tide dashboard]: https://prow.k8s.io/tide