-
Notifications
You must be signed in to change notification settings - Fork 38.6k
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
kubernetes/client-go:.github/PULL_REQUEST_TEMPLATE.md is unhelpful plus suggestion about SIG labelling #122238
Comments
This issue is currently awaiting triage. If a SIG or subproject determines this is a relevant issue, they will accept it by applying the The 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. |
/sig Contributor Experience |
@jsoref: The label(s) In response to this:
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. |
Please note that the bot @k8s-ci-robot said
|
/sig contributor-experience |
@k8s-ci-robot 's help should say |
/kind feature The existing template provides some help; this is a request to make it even more helpful. I presume we could repeat that for lots of other automatically managed Git repositories. Thank you for the suggestion. |
Not quite. The SIG that looks after this automation is SIG Testing. |
/retitle kubernetes/client-go:.github/PULL_REQUEST_TEMPLATE.md is unhelpful plus suggestion about SIG labelling |
@sftim: wait, the Column Title clearly says |
Note: I'm willing to do this work if people can point to the places and offer to support me doing the work. |
This seems like at least a dozen different issues filed as one enormous issue which makes it difficult to actionably fix them. I appreciate that these things are painful and writing them up to highlight them is potentially useful but as only one large issue they're difficult to follow up on, remember that many responding to these are also likely seeing an influx of issues. SIG Testing runs and implements the automation, but currently Contributor Experience maintains that all contributor facing changes to the behavior must be approved by them, including changes to the help text ... The robot currently grew out in https://github.com/kubernetes/test-infra (though we're hopefully about to break it out into a distinct kubernetes-sigs/prow repo ...). The I can't offer much bandwidth myself at the moment, there's too many things to take care of. Usability papercuts pile up but the thing is no one is paying people to work on the robots much anymore and volunteers are pretty busy trying to keep things running (e.g. kubernetes/k8s.io#6165). Some of the maze of links is because there's a generic template project with stub files, and client-go just has the stub files. They might accept adding more details, IMHO it would be good for the staging repos to have their own more-specific CONTRIBUTING.md contents that contain the details on how to contribute to these. The template repo stub files explicitly suggest that subprojects add their own details but that hasn't happened here yet. |
Also comments like:
Are a bit over the top. Mistakes happen, missing the case on this isn't any contributor intentionally disrespecting anyone or any company. As for the values reference: The point of "Community over product or company" is that we strive to make decisions and take actions on the basis of what's best the project at large rather than favoring a particular company including our own employers, and the project on the whole aims for vendor-neutrality. It's impolite not to assume best intentions. These docs could use more contributors cleaning them up.
The contributor guide is general to anyone looking to contribute, the bot links to this rather than duplicating most of this content somewhere else. We should probably start linking to https://www.kubernetes.dev/docs/guide/ instead of github. I'm not sure if Contributor Experience considers this replacement ready though, there was a period where there were two copies of the contributing docs with one intended for this site and one the legacy content ...
GitHub looks for a code-of-conduct.md and marks if a repo has one or not. |
Sorry. For pretty much every item I enumerated, I'm willing to do the work to improve the experience (as long as people are willing to help me deal with whatever hurdles I might encounter, whether that's policy, bots, quirks, or just a lack of an obvious path forward). I happen to have a tool that works on spelling things (including branding items like YouTube) and thus that's actually the easiest item for me to fix. But yes, this is absolutely death by a thousand paper-cuts. I understand you're low on volunteers, but if the hurdle to get through the door is sufficiently high, you won't get many more and you'll continue to bleed or hemorrhage as applicable. Anyway, pick 5 of the paper-cuts identified above that you (the project, not the person) are willing to let me improve, suggest a general direction that would be acceptable to the project and I'll see what I can do. One approach I've found that works well for things like this is for me to "sit" (virtually or physically) with someone and go over a section asking questions, clarifying, and fixing things. It's usually possible to get some portion fixed in 15 minutes, although longer runs can take half an hour or an hour, but conveniently whatever is addressed is a clear improvement and it's an interruptible/resumable process as it's unlikely that anyone else will be changing the process or the documentation between interrupting and resuming. I haven't even gotten to the paper-cuts involved in actually trying to make a contribution for this project.
|
None of the staging-derived repos actually take PRs (the doc says "Please send pull requests against the client packages in the Kubernetes main repository. Changes in the staging area will be published to this repository every day.") Yeah, many of these issues suck, I agree, but really you should not be able to open a PR against client-go at all, right? Can we just turn that off and emphasize the "PRs go to k/k/staging/k8s.io/client-go" instead? @kubernetes/owners |
GitHub allows disabling issues for a repo but not pull requests. We could add another bot behavior to auto-close PRs to these. Not great. |
Fwiw, GitHub itself has the ability to block PRs: Try loading: github/gh-actions-importer@main...add-tests-for-executable
See You'd need to renew it every 6 months (I'd suggest renewing it every 5 months). |
The Kubernetes project currently lacks enough contributors to adequately respond to all issues. This bot triages un-triaged issues according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
/remove-lifecycle stale |
What happened?
Drafting a PR to the kubernetes/client-go repo results in an unhelpful message with prose, but, no links, and the referenced content is a number of indirections away from anything remotely helpful.
What did you expect to happen?
The contents of the pr template should include links to relevant and helpful files. -- The
README.md
text should be a link to the master/HEAD file (this won't hurt someone who decides to edit the readme file in the repository or has already done so), and a reference to contributing should be a link to something that's useful and doesn't require following multiple links to get to an actual contributing file with useful information.How can we reproduce it (as minimally and precisely as possible)?
README.md
andCONTRIBUTING.md
aren't links to anything which means you now have to go back x pages just to try to find themREADME.md
isn't applicable, you now have to browse to (many steps, especially if you didn't start in the repository itself, which you won't in most cases, e.g. here, ...) and openCONTRIBUTING.md
Contributor Guide
section which instruct you to read "this page" (which is not really where you are -- you're actually in a directory)YouTube
is misspelled on this page as well as on the previous page -- apparently respect for other brands isn't a community value (this does appear to be the case, remember if you read https://github.com/kubernetes/community/blob/master/values.md#community-over-product-or-company that the "value" is "Community over product or company")remote
a link to something?remote
you'd discover it's from 2021 and has misbrandedyoutube
differently (instead ofYoutube
)...area
andsig
and all the things you might need to actually understand to actually contribute to kubernetes/kubernetes are absent.YouTube
correctly. Unsurprisingly they did not writeZoom
correctly.Anything else we need to know?
https://github.com/kubernetes/client-go/blob/master/.github/PULL_REQUEST_TEMPLATE.md
I understand that you don't want to maintain the repository itself, but by the time a user sees this message, they've already tried very hard to compose a PR, they shouldn't be forced to do many jumps of indirection and jump through many hoops to get to a place that tells them where to go.
If retaining a reference to
CONTRIBUTING.md
in the kubernetes/client-go repo is deemed essential, it should really be a link to https://github.com/kubernetes/client-go/blob/HEAD/CONTRIBUTING.md (if you're afraid that somedaymaster
will be replaced bymain
...) instead of just words -- if a user already tried to do a thing, giving them a message that requires them to take x steps instead of a path forward is really frustrating.And that
CONTRIBUTING.md
confusingly (it has more words than the thing it) points to https://github.com/kubernetes/kubernetes/blob/master/CONTRIBUTING.mdwhich then points to another contributing guide: https://github.com/kubernetes/community/tree/master/contributors/guide
Kubernetes version
N/A
Cloud provider
N/A
OS version
Web submission
Install tools
No response
Container runtime (CRI) and version (if applicable)
No response
Related plugins (CNI, CSI, ...) and versions (if applicable)
No response
The text was updated successfully, but these errors were encountered: