Kubernetes Kubernetes Contributor Summit - NA (San Diego) 2019, 27 Nov 2019

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Contributor Summit NA 2019: Intermediate Contributor Workshop - Your First PR, What To Expect...

Description

Intermediate Contributor Workshop - Opening Your First PR: What To Expect, And Where To Go Next (membership, finding a reviewer)

Event link: https://events19.linuxfoundation.org/events/kubernetes-contributor-summit-north-america-2019/
Session link: https://sched.co/WrhM

A

Right. so next up we have opening a pull request. Revisited.

A

All right, who follows this: guy on twitter cause you totally should.

A

It's highly serious. um,, highly recommended. um,.

A

So I was going to talk about that at the very beginning of today when I wanted.

A

To demonstrate that the workflow for a kubernete's pull request, um,.

A

Because you are all in the intermediate workshop, um,.

A

There is a session called, gets tips and tricks for kubernetes contributors that.

A

Will go into the depths of the get work flow for kubernete's as well.

A

So I don't want to belabor that part too much. um,.

A

And I want you to also take your questions to that and um, and,.

A

And that should introduce you to some of these things. um, however,.

A

Rolling back into kubernetes being a huge project with thousands of contributors.

A

And many maintainers, it can be incredibly difficult to get attention on your pull. Request.

A

Remember how I asked,, who here has opened a pull request?? I was, you know,.

A

Like roughly about 10 people- and I think the only person who actually had a pull.

A

Request successfully merged was one.

A

So that's not great., and I am here to tell you that that happens and we are trying to make it less.

A

Common and less of a thing. and, um,.

A

I will also give you some tips to make sure that you get the attention on your.

A

Work that it should, that it deserves.

A

Mmm. we already talked about finding an issue.. You can go ahead and look in any case.

A

Yes. I have a question. there's a question.

A

Um,, I'm going over them right, now.

A

A

um, they, I,. I will talk about them., um,, so,,.

A

Uh, yeah, right, right here., so I'm finding something to work. On., um,.

A

We have talked about, uh,.

A

We have talked about how to look for good first issues. um,.

A

Sometimes you bring your own issue. um,. There is also,.

A

If you want to make big changes to the way kubernetes works,.

A

We have a process for that.

A

and that is a kubernete's enhancement, proposal.

A

I do not recommend that new contributors start.

A

A

It has happened, and people have been successful,.

A

But it is not something that I recommend.

A

I am so proud of you., I'm so impressed.

A

I'm so in kubernete's enhancements, you will find the information that you need to file a kubernete's enhancement.

A

Proposal, small bug, fixes.

A

Go ahead and submit a pull, request. big change, proposals,.

A

Submit a cap. um,.

A

One thing that you need to submit the kept successfully is you need to.

A

Collaborate with a sig., you need to join a sig that owns that part of the code that you want to change.

A

And you need to propose to them., you need to have conversations. please, please,.

A

Please do not do a whole lot of work.

A

Submit an enormous pull request and then wait because you have to talk to.

A

Everyone first. um, most of the time,.

A

Even if your idea is great and perfectly execute- and everyone wants it,.

A

People also would want input. um, that's,.

A

That's a part of open source. um,.

A

Look at the contributor guide., I dropped the link in there.

A

In the contributor guide, we talk about common ways to communicate,.

A

Common ways to uh, to get feedback on your pull request.

A

There is a style guide.. There is a get commit guide as well.

A

I already talked about trying not to do too much at once.

A

And this is a cool message.

A

A

There you go. all right,, let's see, what was this?, I'm not boil the ocean.

A

Okay, so when I opened a pull request, earlier,.

A

Follow the steps. um, follow the steps as outlined in the pull request. Template. um,.

A

The one of the very first things that will happen is a bot will talk to you.

A

Please do not ignore the bot.. Please do not hurt its feelings.

A

The bod has important information and it wants to tell you things.

A

There is a couple things this bully quest, woopsies, that move, um,.

A

It will tell you, nope.

A

It will ask you to assign additional approvers.

A

When we say approvers, often, we mean reviewers.

A

Basically, what we want to happen is we want to have people, take a look at your.

A

Pull requests and there is two kinds: reviews.

A

One of them is an in depth code review and the other one is a code approval,.

A

Meaning somebody with the authority and we'll get into the authority in just one.

A

Second. we'll come along and say,, I'm okay with this.

A

change. That might not be an indepth code. Review.. You need both.

A

Some kubernetes sub repositories, other than core kubernete's, will require more.

A

Than these two reviews., they will require multiple code reviews or multiple approvals.

A

Sometimes, if you're submitting work from different sigs,.

A

You might have to get approval from both sigs.

A

Most of your reviewers will come from the code owners.

A

That is also how the bot knows where to find your reviewers.

A

Let me show you that real quick., if we, nope,,.

A

Your scroll is wrong. Alison.

A

I have my track. pat said: differently. um,.

A

One thing you will see in many,: if not all kubernetes repositories are owners files.

A

In an owner's file are the github handles of potential reviewers and approvers.

A

Um,, reviewers and approvers are members of standing that have knowledge and.

A

Ownership of a certain part of the code base., we are looking at the top level owner's file,, which is why there's famous names in there..

A

I am also in a couple of owners: files,, not the top level one, because I wasn't there when people build kubernetes.

A

Um, but uh, I can approve things. for example,.

A

In our pull request, template folder.

A

Right here,, it's a totally different set of people. and this,.

A

These are mostly members of sig contributor experience because we are trying to.

A

Make the public quest template to look as useful and friendly as possible.

A

So when the bod tells you what to do,, the bot pulls your reviewers from the owners, files.

A

The bot will also ask you,: please talk to me..

A

The way to talk to the bot is with a slash command.

A

Um,, let's go ahead and.

A

We have a little bit of time,.

A

A

96.: let's go to the contributor playground.

A

And I'm going to go to an issue right here., I'm going to show you how you talk to the bach.

A

So right here.! So if you want to play around with a kubernete's contributor, bot,.

A

The contributor playground,, it was a great place to do. so., feel free to open issues, play around, check your cla. um,.

A

This is really just a place,. This is how I experienced the kubernete's workflow.

A

Um,, this is not actual code.. This is really just like, hey,.

A

I'm not sure how to talk to the bot. and I'm going to test this out.

A

So in this issue for example,, when I'm going to do, is I'm going to try and um,.

A

Follow one of the bot prompts which here,.

A

Nope,, there's no bot., I'm going to go ahead and say a sign.

A

Go and have your sanger,, which just me, I'm on allison's computer right, now.,.

A

A

and then what we'll do [inaudible] happen up here. now, I'm as an assignee.

A

Notice how if you're used to using goodhub, a lot of the time you think click on github and say like,!

A

I want this person to review my code.. Well, your account, you've got to talk to the bot. um,. That part is disabled, even if you are an org member.

A

No,, that is an excellent question.. Thank you for asking..

A

The reason why it works this way is because it's a huge open source project.

A

We often get spammed if we actually allowed people to have a gooey access to the.

A

Code, bad things can happen.

A

Some of our top level reviewers can actually click on buttons and they have done.

A

So mistakenly and it has broken kubernete's., so we have a lot of info., so the kubernetes bot and the infrastructure around it,, um, is,.

A

Is built to make sure that all of our workflow is automated.

A

Um,, the automation controls when things merge the automation, controls,.

A

Who gets to approve things for merging the automation controls who gets,.

A

Well,, you can assign people,, but you can't click on people's faces.

A

You have to tell the bot, I want to assign this person.

A

And the bottom will sometimes tell you, um, I can't,.

A

I can't assign,, I can't assign this person, or I can't do this. for example,.

A

Um,, if I,, if I have my own pull request, open,.

A

Let's see, where is my pull request?? Let's see. do I still have it? um,.

A

I opened the pull request earlier if I went to head- and I talked to this- pull.

A

Request and I said, so currently, if you look on the left,.

A

There was no approvals,, no code, approvals, nothing.

A

If I want to head, well, this is alison. now nevermind.

A

If I hit and say approve.

A

Or if alison approves this,, the bot will say the blog will actually do nothing.

A

Because alison not have authority to approve anything in this part of the code.

A

Base.. This is why it is important for the bot to discover which sig owns this part of.

A

The code and also.

A

Whom to assign. so right here, the pr will say you can assign the pr to them by writing,.

A

Slash, assign and then their user handled., so I'm going to do that.

A

So I'm going to send jordan, sorry jordan.

A

And now I have an assignee.

A

The reviewers, by the way, were assigned by the bot automatically.

A

So a long story, short,.

A

Look at what the bot prompts you to do and follow the instructions.

A

Some of this, the bot will do automatically depending on where you are in the repo..

A

Sometimes the audit detect works really well..

A

Sometimes the bot doesn't know exactly who,.

A

Who owns this part of the code base or who is a best reviewer.

A

So they'll make suggestions and you'll have to go and ask humans to help. You.

A

With your work.

A

Um, I already kind of talked about labels and bod commands.

A

You talk to the bot with a slash.. There is a slide right here. That shows you all the commands that you can do with.

A

Uh,, the kubernetes bot. um, back to this.

A

Uh,, if you have seen the pull request,.

A

We are looking at a long list of labels on the side and the automation is driven.

A

By those labels.

A

Um,, the bot will also run the test again for you.

A

If your tests fail,, you tell the bod,, hey, slash, retest.,.

A

If you don't know, if you get stuck, ask for help.

A

We have several slack channels., the two friendliest ones are sig contributor experience and there's also an.

A

Entire slack channel for pr reviews.. So if you have trouble finding a reviewer,.

A

Go ask in there, jump up and down.

A

You also now know me if somebody,, if your pr is perishing and you really,.

A

Really want it, merged, send me a slack diem.. It is okay.

A

Um, I will, I will,. I will look at your pull request and see if I can find the right people to get.

A

You going. again,. This ties into make yourself a member of the community.

A

Join a sig. join the mailing list of that sig.

A

Go meet the people at the sig, meet and greet later, today.

A

Ask how you can help some sigs are super friendly and have a really awesome.

A

Onboarding process and other sigs need help with that. Too.

A

Welcome to open source., if you see something that's broken,.

A

Whether it's code or a process, start fixing it.

A

Eventually, you'll own it and it, and you'll help make things better.

A

Um, we talked about finding a review. um,.

A

Follow the prompts. if there is an issue associated with your pull request,.

A

Go find the author of that pull request on kubernetes slack., send them a dm.

A

Say, hey, I've been working on this.. Can we collaborate?.

A

Um, check the owner's file for who you see., who else you can assign as an approver.. Please be patient.

A

Your viewer might be asleep, you're, a viewer, might be on vacation.

A

You don't know,, you don't know where they live., you don't know. Who,.

A

Who they are. um,, but you know,, give it,, give it some time.

A

Give it at least a few days before, before you start escalating.

A

I already mentioned the pr reviews, slack channel. uh,.

A

Pr reviews., oh, sick, contribute to your experience.

A

I think it might even be sig contrib x.

A

It is. yeah., so contrib x.

A

And if you find parts of this process that are too broken for you to deal with,.

A

Come and tell us in sig contributor, experience,.

A

We'll make sure that people listen to their charters., so pr workflow, recap,.

A

You submit a pull, request, use, the template,, you add labels using the bot commands,.

A

The bots will comment and help you out with that. things. You will see,.

A

Do I need a release? Note? have I signed the contributor license agreement?.

A

The needs, okay to test flag will happen if you do not have org membership.

A

Um,, that just means that we need an org member to come and verify that you're for.

A

Real and you're, not spamming, us.

A

and usually it's usually you'll, be collaborating with someone already and.

A

They're like,, oh yeah, yeah,, this person's legit. the tests can run. um, again,.

A

This is a good thing to ping me for. they're, like, hey,.

A

I attended the new contributor workshop., I'm trying to submit something and the bot won't even run the test. um,. I can,.

A

I can have that for you., then you will often see needs kind and need,.

A

See that should be part of the pull request, template and sometimes the bot will.

A

Automatically assign a sig for you as well. um,.

A

So keep that process up. uh, once you have an approver and a reviewer and go through the code process. Review,.

A

Be responsive, get back to your work, address comments,.

A

Make sure that you fix things, take suggestions,.

A

Bring it to the sig meeting and say, hey,, I was working on this.

A

I'm not sure what to do. um,.

A

Then, once the tests pass, there was this period of nothing.

A

Upr just fits there., it has all those labels and nothing happens and there's no merge button.

A

You wait., the next thing that happens is that the automation called tide will merge. Your.

A

Pr on the next batch. so just sit tight and wait.

A

And upr will emerge in the order. It was received.

A

Um,, this is just an example of a really nice. First time pull request. um,.

A

Person is using the correct box commands., it says this is a feature,.

A

Not a bug, not, not,, not a cleanup., see all the labels on the side.

A

There's the kind of feature label. there was the approved label. um,.

A

There was an okay to test flag, because this person is not an org member and.

A

Needed that extra flag. um,.

A

And this person also went through and gave special notes.

A

This is the first time, I'm writing any go. Code. do that, communicate,.

A

Let people know. um,, because it's always better for people to have more context than us.

A

And then she also is describing really well like what is happening when she's.

A

Trying to run. make- perhaps some of you have seen this message earlier: today.

A

I already bought up the contributed playground play around with the bot automation on this repository.

A

Membership org membership.

A

I dropped a link for you. org membership is not supposed to be difficult.

A

Everyone in this room is a kubernetes contributor.

A

None of the one in this room is an org member..

A

Once you have a couple of pull requests or you have collaborated on a project,.

A

You have been on a working group, you've served on the release team for a term.

A

Actually, when you join the release, team will probably sponsor you for org.

A

Membership., the membership guidelines are vague on purpose because everyone's contributions.

A

Are different.? You do not need to get patches into kubernetes,.

A

Kubernetes to be an org member.

A

You can get patches into kubernetes test inference,, you can work on the docks,.

A

You can work on the community docs and the community processes. um,.

A

It is not supposed to be a high hurdle., it is really just a verification for us,.

A

The community to be like, hey,, this person is involved in this person, is serious about joining the community.

A

Once you have a few pull requests, filed a few issues,, you know,.

A

Anywhere from two to five things, go ahead and find yourself two sponsors and ask for org membership, and we will.

A

Give it to you.: this is the contributor ladder.

A

Everyone is a contributor that contributes to the project. um,.

A

Once you have sponsorship by two, uh, code, reviewers,.

A

Uh, there was a couple of rules.. You can look at the exact rules., you are a member., then the next tiers are reviewers and approvers..

A

This means you are your name,, your handle is in one or more of the kubernetes owners, files. and again,.

A

It does not have to be core kubernete's., it can be kubernetes community,.

A

It can be, you know, kubernete's, sigs, kind. um,,.

A

But once you have knowledge, once you've proven yourself, you will, uh,.

A

You will be, you will, well,. Usually people pull requests themselves into the owners file because they're.

A

Like, hey,, I can start, you know, contributing to code review. um,.

A

And that is how you climb the contributor ladder.

A

So it looks a little bit like a reviewer is like a level above.

A

But what it really means is that you have ownership of part of the code.

A

It's not like you, don't have to know all the kubernetes things to be a reviewer,.

A

But if you're good at storage,, maybe you are now a reviewer of all the things that are kubernetes storage.

A

Related, for example.- and I hope that was clear as mud.

A

The top level owner is literally the people who know all the things about.

A

Kubernetes. um,, so somebody who always all of kubernete's test infra would be an owner that is.

A

Basic., it's basically defined by an entry in the top level owners file of an org repo.

A

Alright., I could talk about releases, but I am at time and I would rather spend time.

A

Answering questions about the pull request: workflow, the membership ladder.

A

Um,, yes, itch. so,.

A

Um,, every once in a while you'll get like a tiny little feature that isn't.

A

Technically a bug fix,, but it's like I'm just enabling this tiny little thing to do. one more thing.

A

And um,, I'm sure this person had conversation beforehand as well.

A

Um,, I don't actually know.. This was really more like she's explaining what is happening. um,.

A

Yeah., so actually I do, I'm not sure about this.. I wasn't there for this.

A

I wasn't reviewing this particular pull. Request. um,, I was just saying this- is a good, um, yes,.

A

For most features., you want to have a discussion with the maintainers and code owners? absolutely.

A

Every once in a while, though, I think in this case this just kind of adds an.

A

Extra functionality that maybe, is only for you play it by ear.

A

If it's not too much, work, try it., but I would always go and talk to people first.

A

The question was, is the playground active and is it a real thing?.

A

The answer to that is yes,. It is active. yes,. It is a real thing.

A

People might not come and merge it,, but I will probably troll the playground for the rest of kubecon and see what.

A

Happens. and if you know, and again, same rules, apply.

A

If you want to submit something,, there's also some real typos in that repo.

A

So if they're legit fixes, go ahead, find me on slack.

A

Ping me,. Let me know. yeah,.

A

Let me go back. pull requests.

A

Oh my pull request. this one.

A

A

A

This pull request has been approved by.

A

It is, it is., it is terribly terrible.

A

This code lives in kubernete's, slash test in front.

A

And it sounds like you found a good first issue.

A

What is the,, what is that second approval? is that.

A

This is actually the person who submitted the pull request.

A

Okay., so it's only,.

A

It says that it has been approved by this person already,.

A

But it needs further approval. good question.

A

It's really, really difficult to fix this language. Unfortunately.

A

That's why it says we suggest the following additional approver.

A

Any other questions?, let's see if I can skip ahead to our contacts., slides.

A

Questions?, oh yeah., so coming up next we have talks at three 30.

A

It's the break right now,, so you'll have a 25 minute break or so. um,.

A

There is resolving conflict, github to avoid all confusion.

A

This has nothing to do with merge. Conflicts..

A

No one is going to teach you how to fix your merge conflicts..

A

This is about human conflict..

A

This is about, if somebody wanders into your repo and is mean to you, what do you do? um, same time? You have a test grid, test,, squid and you,.

A

This is talking about the kubernetes test, grid., we have a lot of test integration and if you want to learn how it works,.

A

That is a good talk to attend. um, check out the unconference cause. That's what I might want my,.

A

What I might do, next. um, and at a four o'clock I already mentioned practical gift for kubernetes.

A

Contributors. um,: this is going to talk a little bit more about the kubernetes get isms. um,.

A

I kind of touched on these this morning..

A

We use a fork and clone method of submitting patches.

A

Then please, please attend the sig meet and greet.

A

Um, we also,, I don't,. I don't know.

A

We're going to,, so we also, we were going to give this book to all the attendees. um,.

A

I do believe we have a code for you that I will post somewhere.

A

Um, and again we can check in with me at the sig, meet and greet where I'll get more.

A

Clarity. however,, who came from furthest away?.

A

Sydney,, who came from city, israel,.

A

A

All right. you find out.

A

Alright, we will have copies of this book, digital copies of this book available for everybody. um,. It is, uh,.

A

Programming kubernetes, developing cloud native applications by.

A

Nikki, michael and blas, and stefan shumanski.

A

And thank you. welcome a board.

A

These are philippian friends sailing into the sunset.

A

Please come join us because I have a contact slide.

A

I don't have a contact slide.. I am so sorry., I'm bad at that.

A

Finding on slack. my flack handles. [inaudible].

A

Let me pull this., let's see., how do I [inaudible].

A

I actually just look for guinevere on kubernetes slug.. There's only me.

A

Also., I welcome some of you in the kubernetes dev channel. earlier today,.

A

I had a contact slide. Oh well.

A

All right., thank you, so much for coming. feel free to come up and say hi.

A

Ask more questions that maybe you didn't want in front of.

A

ask in front of everybody.