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

Post onboarding information for new contributors' first PR #3083

Closed
xiangpengzhao opened this issue Jun 16, 2017 · 41 comments
Closed

Post onboarding information for new contributors' first PR #3083

xiangpengzhao opened this issue Jun 16, 2017 · 41 comments
Assignees
Labels
area/prow Issues or PRs related to prow sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience.

Comments

@xiangpengzhao
Copy link
Contributor

There are so many PRs named Release 1.6 which are created by new contributors.

kubernetes/kubernetes#47418
kubernetes/kubernetes#46616
kubernetes/kubernetes#45470
kubernetes/kubernetes#45396
kubernetes/kubernetes#45205
kubernetes/kubernetes#44823
kubernetes/kubernetes#44183
kubernetes/kubernetes#43733
kubernetes/kubernetes#43547
......

These PRs have the same name and the same info as below:
xx wants to merge xx commits into master from release-1.6

They're obviously created by some same mistake. The creator might haven't read the develop docs before they create the PR. They might not know where to find the docs.

We'd better let bot post some onboarding information when it detects a PR is created by a new contributor. So that they can know what's the correct process to create a PR. This will help them not make mistake next time whether their first process is correct or not.

xref:
kubernetes-retired/contrib#1090
kubernetes/kubernetes#36596

/cc @bgrant0607 @ConnorDoyle @grodrigues3

@fejta fejta added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Sep 30, 2017
@fejta
Copy link
Contributor

fejta commented Sep 30, 2017

How do we know if it is their first PR? Might make for an interesting welcome plugin (maintain a list of seen users?)

@BenTheElder
Copy link
Member

BenTheElder commented Sep 30, 2017

I think the most workable solution right now is to make sure the default PR text points you to the contributor guide (which I think it already does now?)

AFAIK you can scrape GitHub for contributor data but there isn't a great way to check per user.
So we'd have to maintain a contributors database ourselves, which would probably be pretty clunky. Example of finding contributors here.
Edit wrong link, I was thinking of this.

@bgrant0607
Copy link
Member

Independently of detecting new contributors it may be useful to detect PRs to the wrong branch, PRs with excessive numbers of commits to the master branch, and other obvious mistakes.

@fejta
Copy link
Contributor

fejta commented Sep 30, 2017

PR Linter? I like it

@xiangpengzhao
Copy link
Contributor Author

Independently of detecting new contributors it may be useful to detect PRs to the wrong branch, PRs with excessive numbers of commits to the master branch, and other obvious mistakes.

Great idea!

@0xmichalis
Copy link
Contributor

/area prow

@k8s-ci-robot k8s-ci-robot added the area/prow Issues or PRs related to prow label Oct 31, 2017
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 29, 2018
@justaugustus
Copy link
Member

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Feb 27, 2018
@BenTheElder
Copy link
Member

I don't think there's API access to this yet but they're definitely tracking first time contributors in the GitHub web interface now.

@nikhita
Copy link
Member

nikhita commented Jun 13, 2018

/sig contributor-experience

@k8s-ci-robot k8s-ci-robot added the sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. label Jun 13, 2018
@BenTheElder
Copy link
Member

This came up again in #sig-contribex slack today, I think we could do this if we:

  • used a dedicated bot account to do the queries
  • just loaded the first page of results from searching for the user's PRs in the repo

If the number of results is exactly one and there are no other pages, it's a new contributor.

This would cost one extra token for every opened PR, which should definitely be very manageable on a dedicated account (it might even be manageable on the existing accounts?). Ex for @nikhita's PRs in test-infra (currently 12):

screen shot 2018-07-10 at 7 50 21 pm

@BenTheElder
Copy link
Member

/assign

@nikhita
Copy link
Member

nikhita commented Jul 11, 2018

. Ex for @nikhita's PRs in test-infra (currently 12)

That's weird because I only have 11 PRs in test-infra. All of them have been merged and none is open right now: https://github.com/kubernetes/test-infra/pulls?q=is%3Apr+author%3Anikhita+is%3Aclosed.

@BenTheElder
Copy link
Member

Ah, there's a typo in that, there shouldn't be a space after is:, which is not restricting it to PRs, so it's actually counting commits.

@matthyx
Copy link
Contributor

matthyx commented Jul 17, 2018

/remove-help

@k8s-ci-robot k8s-ci-robot removed the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Jul 17, 2018
@stevekuznetsov
Copy link
Contributor

Implemented in #8643
/close

@k8s-ci-robot
Copy link
Contributor

@stevekuznetsov: Closing this issue.

In response to this:

Implemented in #8643
/close

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.

@BenTheElder
Copy link
Member

/reopen
we still need to enable and validate this feature, I can do that today
then we'll want to track getting a real, good welcome message configured

@k8s-ci-robot
Copy link
Contributor

@BenTheElder: Reopening this issue.

In response to this:

/reopen
we still need to enable and validate this feature, I can do that today
then we'll want to track getting a real, good welcome message configured

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.

@k8s-ci-robot k8s-ci-robot reopened this Aug 31, 2018
@BenTheElder
Copy link
Member

#9227 to enable testing this on test-infra

@BenTheElder
Copy link
Member

BenTheElder commented Aug 31, 2018

#9231 did not work, I think
the query works but possibly we need to delay checking as the API does not immediately reflect this? we need to check for <= 1 instead of exactly 1 😬

@BenTheElder
Copy link
Member

filed a fix #9232

@BenTheElder
Copy link
Member

can confirm that this works now #9350 (comment)

@spiffxp
Copy link
Member

spiffxp commented Oct 23, 2018

What's keeping this open at this point?

@xiangpengzhao
Copy link
Contributor Author

Seems like it's done. I'm okay to close it. @BenTheElder any other concerns ? Feel free to close it if needed.

@BenTheElder
Copy link
Member

We still need to actually post onboarding info. The tooling works but the words need smithing :+)

@xiangpengzhao
Copy link
Contributor Author

@BenTheElder is the plugin deployed in k/website? I don't see the onboarding info in kubernetes/website#10712

@nikhita
Copy link
Member

nikhita commented Oct 24, 2018

is the plugin deployed in k/website?

@xiangpengzhao Nope, only test-infra.

welcome:
- repos:
- kubernetes/test-infra
message_template: "Welcome @{{.AuthorLogin}}! It looks like this is your first PR to {{.Org}}/{{.Repo}} 🎉🎉"

@xiangpengzhao
Copy link
Contributor Author

Thanks @nikhita !

@BenTheElder
Copy link
Member

poke! this plugin seems to be working pretty well where it is deployed, we just need to do #9367 (comment) and then roll it out more widely

@BenTheElder
Copy link
Member

this is basically done?

it might be rolled out more at some point, but the tooling is there and enabled for some repos at least.

@nikhita
Copy link
Member

nikhita commented Apr 15, 2019

this is basically done?

Yup. Thanks Ben and Guin! :)

/close

@k8s-ci-robot
Copy link
Contributor

@nikhita: Closing this issue.

In response to this:

this is basically done?

Yup. Thanks Ben and Guin! :)

/close

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.

@BenTheElder
Copy link
Member

BenTheElder commented Apr 15, 2019 via email

@nikhita
Copy link
Member

nikhita commented Apr 15, 2019

/reopen

@k8s-ci-robot
Copy link
Contributor

@nikhita: Reopened this issue.

In response to this:

/reopen

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.

@k8s-ci-robot k8s-ci-robot reopened this Apr 15, 2019
@nikhita
Copy link
Member

nikhita commented Apr 15, 2019

Will follow up on this next week

@nikhita
Copy link
Member

nikhita commented May 2, 2019

FWIW last I saw still it was still not enabled generally.

Thought so too....but turns out it is :P

welcome:
- repos:
- kubernetes
- kubernetes-client
- kubernetes-csi
- kubernetes-incubator
- kubernetes-sigs
message_template: "Welcome @{{.AuthorLogin}}! <br><br>It looks like this is your first PR to <a href='https://github.com/{{.Org}}/{{.Repo}}'>{{.Org}}/{{.Repo}}</a> 🎉. Please refer to our [pull request process documentation](https://git.k8s.io/community/contributors/guide/pull-requests.md) to help your PR have a smooth ride to approval. <br><br>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](https://go.k8s.io/bot-commands). <br><br>You can also check if {{.Org}}/{{.Repo}} has [its own contribution guidelines](https://github.com/{{.Org}}/{{.Repo}}/tree/master/CONTRIBUTING.md). <br><br>You may want to refer to our [testing guide](https://git.k8s.io/community/contributors/devel/sig-testing/testing.md) if you run into trouble with your tests not passing. <br><br>If you are having difficulty getting your pull request seen, please follow the [recommended escalation practices](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#why-is-my-pull-request-not-getting-reviewed). Also, for tips and tricks in the contribution process you may want to read the [Kubernetes contributor cheat sheet](https://git.k8s.io/community/contributors/guide/contributor-cheatsheet/README.md). We want to make sure your contribution gets all the attention it needs! <br><br>Thank you, and welcome to Kubernetes. :smiley:"

@nikhita
Copy link
Member

nikhita commented May 2, 2019

/close

@k8s-ci-robot
Copy link
Contributor

@nikhita: Closing this issue.

In response to this:

/close

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/prow Issues or PRs related to prow sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience.
Projects
None yet
Development

No branches or pull requests