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

Add guidance for contributors who want to help with the PR backlog #46141

Open
shannonxtreme opened this issue May 2, 2024 · 9 comments
Open
Labels
kind/feature Categorizes issue or PR as related to a new feature. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. sig/docs Categorizes an issue or PR as relevant to SIG Docs. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@shannonxtreme
Copy link
Contributor

shannonxtreme commented May 2, 2024

We should have guidance for new contributors and org members for how to filter through the project's PR backlog and contribute towards reducing it. This guidance should cover the following points (thanks @sftim):

  1. Our goal to have ≤ 100 open English PRs in the project
  2. New contributors and org members:
    1. Filter for PRs that:
      • Don't have an LGTM label
      • Are in the contributor's preferred language
      • Don't already have a useful review left by someone else. Useful meaning substantial - if the previous review is typos or nits, worth looking into.
    2. Sort by oldest first and work forwards in time
  3. Reviewer role:
    1. Link off to role responsibilities

This content should probably go into https://kubernetes.io/docs/contribute/review/reviewing-prs/ and potentially be linked to from https://github.com/kubernetes/community/blob/master/contributors/guide/review-guidelines.md (although that's for all contributors and not just docs)

/sig contributor-experience
/sig docs

@shannonxtreme shannonxtreme added the kind/feature Categorizes issue or PR as related to a new feature. label May 2, 2024
@k8s-ci-robot k8s-ci-robot added sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. sig/docs Categorizes an issue or PR as relevant to SIG Docs. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels May 2, 2024
@sftim
Copy link
Contributor

sftim commented May 3, 2024

This content should probably go into https://kubernetes.io/docs/contribute/review/reviewing-prs/ and potentially be linked to from https://github.com/kubernetes/community/blob/master/contributors/guide/review-guidelines.md (although that's for all contributors and not just docs)

Can we put it into https://k8s.dev/docs/ and link there? It'll be English-only, but that's OK: everyone who works on PRs should have at least some familiarity with English.

@divya-mohan0209
Copy link
Contributor

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels May 4, 2024
@divya-mohan0209
Copy link
Contributor

I agree with @sftim's point since filtering and contributing also fit into the scope of the wider project. Amending k8s.dev & linking it somewhere in our contributing docs should help.

@natalisucks
Copy link
Contributor

natalisucks commented May 4, 2024

@shannonxtreme Can you please revise the following guidance:

Our goal to have ≤ 100 open PRs in the project

Our goal is to have approximately 100 PRs open for English language and site-wide changes. This is an important distinction because we have a lot of localization PRs that aren't under the purveiw of PR wrangling, but are rather the domain of localization teams, and their resources are decidely smaller than the SIG-wide reveiwers pool.

@shannonxtreme
Copy link
Contributor Author

Thanks Natali, added. @divya-mohan0209 @sftim for the k8s.dev one, I was looking at that and it didn't seem like we had a "guidelines for PR reviews" type document there. That's why I ended up in the k/community repo, which does have that guidance. Do you think that it's worth creating a new page in k8s.dev/docs instead?

@priyanshsao
Copy link

can i work on this issue?

@shannonxtreme
Copy link
Contributor Author

Yes @priyanshsao but maybe let's get confirmation in these comments about where exactly to put this information before you do a PR!

@divya-mohan0209
Copy link
Contributor

@shannonxtreme : Good point! I would suggest that it be added as a section into the pull requests guide on the k8s.dev site since there's already information that is very similar to the information that we're trying to put forth. Thoughts?

@shannonxtreme
Copy link
Contributor Author

@divya-mohan0209 That page seems to be tightly focused on submitting a PR, not reviewing one. What about https://www.kubernetes.dev/docs/guide/contributing/#code-review ? There's a section there for reviewers about the expectations for them. Maybe a subsection under Code review for PR reviewer guidelines?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. sig/docs Categorizes an issue or PR as relevant to SIG Docs. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

No branches or pull requests

6 participants