Skip to content

Suggestion: Improve Contributor Guide for First-Time PR Process Clarity #8442

@klu2300030052

Description

@klu2300030052

Describe the issue

Hello Kubernetes community 👋,

While exploring the contributor documentation, I found that the first-time pull request (PR) workflow could benefit from additional clarity—especially for newcomers. Specifically:

The steps around forking, branch naming conventions, and CLA (Contributor License Agreement) signing are not clearly linked together.

There’s some redundancy in information between the Contributor Cheat Sheet and Pull Request workflow guide.

The use of tools like git rebase versus git merge is briefly mentioned, but not explained with context or examples.

💡 Suggested Improvements:
Add a beginner-friendly section in the PR guide with a flowchart or visual diagram of the process.

Include direct links to GitHub's fork and PR guides within the contributor cheatsheet.

Add a short example showing a sample workflow for making a PR (from fork to merge).

I'd love to help contribute to this if the maintainers think it's worth refining!

Thanks 😊

Metadata

Metadata

Assignees

No one assigned

    Labels

    lifecycle/staleDenotes an issue or PR has remained open with no activity and has become stale.needs-sigIndicates an issue or PR lacks a `sig/foo` label and requires one.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions