Skip to content

add a quick how to start section to README #3575

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Sep 16, 2025
Merged

add a quick how to start section to README #3575

merged 1 commit into from
Sep 16, 2025

Conversation

olamilekan000
Copy link
Contributor

Summary

Change adds a "Quick Start for Development" section to help developers get kcp
running locally with setup instructions.

What Type of PR Is This?

/kind documentation

Related Issue(s)

Fixes #
Fixes

Release Notes

NONE

@kcp-ci-bot kcp-ci-bot added release-note-none Denotes a PR that doesn't merit a release note. dco-signoff: yes Indicates the PR's author has signed the DCO. kind/documentation Categorizes issue or PR as related to documentation. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 11, 2025
@kcp-ci-bot
Copy link
Contributor

Hi @olamilekan000. Thanks for your PR.

I'm waiting for a kcp-dev 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/test-infra repository.

@olamilekan000 olamilekan000 force-pushed the add-quick-how-to-run-session branch from d90547a to d9f6b3c Compare September 11, 2025 08:36
@kcp-ci-bot kcp-ci-bot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 11, 2025
@olamilekan000 olamilekan000 force-pushed the add-quick-how-to-run-session branch 3 times, most recently from 6872ab9 to 3001dac Compare September 11, 2025 08:49
@kcp-ci-bot kcp-ci-bot added dco-signoff: no Indicates the PR's author has not signed the DCO. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. dco-signoff: yes Indicates the PR's author has signed the DCO. labels Sep 11, 2025
@olamilekan000 olamilekan000 force-pushed the add-quick-how-to-run-session branch from 3001dac to 4f125cc Compare September 11, 2025 08:51
@kcp-ci-bot kcp-ci-bot added dco-signoff: yes Indicates the PR's author has signed the DCO. and removed dco-signoff: no Indicates the PR's author has not signed the DCO. labels Sep 11, 2025
@olamilekan000 olamilekan000 force-pushed the add-quick-how-to-run-session branch 2 times, most recently from 7b52bab to 87e2d38 Compare September 11, 2025 08:52
@olamilekan000 olamilekan000 changed the title add a quick to start section to README add a quick how to start section to README Sep 11, 2025
embik
embik requested changes Sep 11, 2025
View reviewed changes
@olamilekan000 olamilekan000 force-pushed the add-quick-how-to-run-session branch from 87e2d38 to 627385a Compare September 11, 2025 14:26
@kcp-ci-bot kcp-ci-bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 11, 2025
@olamilekan000 olamilekan000 requested a review from embik September 11, 2025 14:27
@embik
Copy link
Member

embik commented Sep 13, 2025

/ok-to-test

@kcp-ci-bot kcp-ci-bot 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 Sep 13, 2025
embik
embik approved these changes Sep 16, 2025
View reviewed changes
Copy link
Member

@embik embik left a comment

Choose a reason for hiding this comment

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

/approve

Thank you for the contribution!

@kcp-ci-bot kcp-ci-bot added the lgtm Indicates that a PR is ready to be merged. label Sep 16, 2025
@kcp-ci-bot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 61d2820c5ca40f59084d225175c17080c16965c9

@kcp-ci-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: embik

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

@kcp-ci-bot kcp-ci-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 16, 2025
@kcp-ci-bot kcp-ci-bot merged commit c4ec6ad into kcp-dev:main Sep 16, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@embik embik embik approved these changes

Assignees

@embik embik

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates the PR's author has signed the DCO. kind/documentation Categorizes issue or PR as related to documentation. lgtm 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/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@olamilekan000 @kcp-ci-bot @embik