Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

issue-3260: Clarify a few points on Development Documentation. #3261

Merged
merged 4 commits into from
Aug 13, 2024

Conversation

jgao1025
Copy link
Contributor

@jgao1025 jgao1025 commented Aug 11, 2024

What type of PR is this?
/kind documentation

What this PR does / why we need it:

As a new contributor, I reviewed the Dev Guide and would like to clarify a few points I encountered while following it. I've made some structural adjustments and added a few pieces of content. I know that this may have some personal opinions, so I'm open to any feedback or comments.

Which issue(s) this PR fixes:

Fixes #3260

Does this PR introduce a user-facing change?:
NONE

Dear reviewers,

You can check the latest changes at here.

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Aug 11, 2024
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Aug 11, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @jgao1025!

It looks like this is your first PR to kubernetes-sigs/gateway-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/gateway-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 11, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @jgao1025. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 11, 2024
@jgao1025 jgao1025 changed the title draft: issue-3260: Clarify a few points on Development Documentation. issue-3260: Clarify a few points on Development Documentation. Aug 11, 2024
@youngnick youngnick added the release-note-none Denotes a PR that doesn't merit a release note. label Aug 12, 2024
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. label Aug 12, 2024
@youngnick
Copy link
Contributor

/ok-to-test
/approve

Thanks @jgao1025, this is great stuff.

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 12, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jgao1025, youngnick

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 12, 2024
Copy link
Member

@mlavacca mlavacca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this PR, @jgao1025!

site-src/contributing/devguide.md Outdated Show resolved Hide resolved
site-src/contributing/devguide.md Outdated Show resolved Hide resolved
jgao1025 and others added 2 commits August 13, 2024 08:16
Co-authored-by: Mattia Lavacca <lavacca.mattia@gmail.com>
@robscott
Copy link
Member

This is really great, thanks @jgao1025!

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 13, 2024
@k8s-ci-robot k8s-ci-robot merged commit 6446fac into kubernetes-sigs:main Aug 13, 2024
8 checks passed
@jgao1025 jgao1025 deleted the issue-3260 branch August 13, 2024 00:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify a few points on Development Documentation.
6 participants