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.

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

Improve formatting and readability of new contributor guide #8153

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Improve formatting and readability of new contributor guide #8153

wants to merge 4 commits into from
+19 −8

Conversation

henriquesantanati
Copy link

This commit enhances the formatting and readability of the new contributor guide. Changes include:

  • Added a main header for the document
  • Organized content into logical sections with subheaders
  • Used bullet points for community joining instructions
  • Numbered the steps for getting familiar with the contribution process
  • Improved overall structure and visual hierarchy

These changes make the guide easier to read and follow for new contributors, potentially increasing engagement and participation in the community.

Which issue(s) this PR fixes:

Fixes #8152

@henriquesantanati
Improve formatting and readability of new contributor guide
b8e9ab0 
This commit enhances the formatting and readability of the new contributor guide. Changes include:

- Added a main header for the document
- Organized content into logical sections with subheaders
- Used bullet points for community joining instructions
- Numbered the steps for getting familiar with the contribution process
- Improved overall structure and visual hierarchy

These changes make the guide easier to read and follow for new contributors, potentially increasing engagement and participation in the community.
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 20, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @henriquesantanati!

It looks like this is your first PR to kubernetes/community 🎉. 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/community 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 area/mentorship-planning Relating to strategy, planning,& executing of mentoring programs. NOT specific mentoring opportunty. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. labels Nov 20, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @henriquesantanati. Thanks for your PR.

I'm waiting for a kubernetes 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.

@palnabarun palnabarun mentioned this pull request Dec 3, 2024
Open
@palnabarun
Copy link
Member

/ok-to-test

@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 Dec 3, 2024
@AmanSarraf
Copy link

hello @henriquesantanati
I noticed you have an existing PR for #8153. I’ve also submitted a PR #8199 and am currently addressing reviewer feedback. Would you be open to collaborating on this, or are you okay with me continuing to work on the updates? Please let me know how we can best proceed.
Thanks!

@henriquesantanati
Copy link
Author

Hello @AmanSarraf ,

I'm Ok either way the collaboration.

Although, it's a bit weird that this PR is open since 15 days ago without reviews and the other with just 3 days is already being reviewed.

jberkus
jberkus reviewed Jan 6, 2025
View reviewed changes
mentoring/new-contributor-orientation/new-contributor-resources.md
# Getting Started with Kubernetes Development

## Join the Community
Copy link
Contributor

Choose a reason for hiding this comment

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

This should contain a back-link to the NCO in the parent directory, in case someone got to this page without starting from that directory.

Copy link
Author

@henriquesantanati henriquesantanati Jan 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Hey @jberkus , thanks for reviewing this.

Do you mean by pointing Join the Community to https://github.com/kubernetes/community/tree/master/mentoring/new-contributor-orientation?

It would be: Join the Community

As soon as you confirm it, I'll push this change.

Copy link
Contributor

Choose a reason for hiding this comment

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

No, I mean adding the NCO to the list of items.

@jberkus
Copy link
Contributor

jberkus commented Jan 6, 2025

This looks good, just requesting one addition.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: henriquesantanati
Once this PR has been reviewed and has the lgtm label, please assign nikhita for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kaslin kaslin Awaiting requested review from kaslin

@MadhavJivrajani MadhavJivrajani Awaiting requested review from MadhavJivrajani

@jberkus jberkus Awaiting requested review from jberkus

Assignees
No one assigned
Labels
area/mentorship-planning Relating to strategy, planning,& executing of mentoring programs. NOT specific mentoring opportunty. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. 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.

Enhance readability of Kubernetes contributor onboarding guide
5 participants
@henriquesantanati @k8s-ci-robot @palnabarun @AmanSarraf @jberkus