Layer5 Newcomers, 15 Oct 2020

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Layer5 Newcomers Meeting (Oct. 15th, 2020)

Description

Contributing to @layer5 projects: A walk-through with Layer5 MeshMate @IkegahRuth during Hacktoberfest.

A

All right, sorry for the delay, folks, um there's a link to the meeting that is in the chat we'll start in there. We'll start now we're five minutes in that's enough time for anybody to join in all right. Let me just share my screen.

A

All right, as always, add your name in and any topic you want in your agenda as you wish.

A

All right um welcome to the third meetup hack to the festival, live five. If you haven't been to the last two well, you missed out, but no issues. We record our meetings. So what you need to do is head out to our youtube channel and go see them you'll find link to this page in the meeting minutes.

A

It includes all of the information that we well that we want to share with you, as I had to be first participant and as a newcomer starting out in the community.

A

You have enough resources here to oops.

A

To start out, you also find a table here that specifies that details out the tutorials that we've had so far and uh shoot the link dismissing here. That will be updated soon enough. um So you can come here and check these out or again. You can go to youtube and check them out. That's your call all right um more for you.

A

Today we have a tutorial git from root and I run through the liferay projects and an overview of the site projects which basically is in our areas that you can contribute to as a best participant or as a newcomen general um to make things exciting for you, we have a meeting stable already and typed up so you'll, never miss a meeting again. You'll find all the links here to the meeting minutes to the meeting links the recordings as well.

A

So that's it never miss out on another cliffhanger meeting we will house you until you come to us.

A

B

Ruth is your audio issues fixed now, hey yeah. Can you hear me yep? I can.

C

A

Wait, uh do you want to start with this.

D

Oh yeah sure hey go ahead.

C

Okay, um I think use okay, stop presenting okay, hello.

C

Everyone sorry give me a second. Let me share my screen.

C

C

C

C

So hi everyone, my name- is ruth ikega from nigeria and amelia 5 mesh mate and today, in this tutorial I'll, be taking you like a walkthrough to contributing to layer, 5 and welcome everyone who is a contributor and welcome everyone who is a hacktoberfest participant.

C

So um in this short tutorial, it's going to be very short, so I'll be taking you through walking through contributing to layer, 5 yeah. So now the first thing for basically why why we put up this tutorial is mainly for the oktoberfest participants like throughout this month. This throughout this month, we've been doing like um every every thursday we're doing a hacktoberfest meetup.

C

So um we might have noticed that some of the hacktoberfest, but who are not contributors, might have been having fun difficult to navigate through um the layer, 5 organization. So the first thing you do when you like hop on to layer 5 is you want? You want to look at the github overview and I'm sure I'm sure to share this slide. I'm sure everybody has access to it. So if you click on this link, it will take you to the layer, 5 overview and repository overview.

C

Guitar- and you can see here- we have like 42 repositories here, different repository. You have like 42 of them, so this this this overview would help you pick which of the repositories or which of the projects in their five. You want to. You want to help contribute to so, and also at this point here, you can search up whatever repository you want to search as far as per day name.

C

So uh that's the first thing you should do then. Now um I I wanted to highlight uh some new comma resources that are really very that really going to very helpful to you. As a newcomer. First, we put up like a new commerce welcome guide and this google doc contains. It contains almost everything you need to know as a newcomer to layer 5. So you should do well to consume this resource and you also have a community guide. These guides also everything about the layer, 5 community.

C

And how to navigate your way through and also if you want to normally do what you should do when you like pop into a project, is consume the readme content of each repository so good enough, we have like an overview of each repository in the they are five community right. So another resource is the good first issues, so we have accumulated.

C

um If you navigate to this, we have completed some good first issues in the layer, 5 organization, so it just makes you it just makes things easier for you. As a newcomer, that's like I, I know you would say we do not mess up with a newcomers experience, so we just make things very, very easy for you. So at the last the last resource, that's very, very important, is uh the contributing guidelines right. So this is really very important because you would understand how to better contribute.

C

You have like a resource together for you to understand how to the repository what it means to a repository to clone to locale and every every step. It's it's a step-by-step procedure and not just a step-by-step procedure, but it's it shows you like why you should do this and why you shouldn't do this right. So please do well to take a look at all these resources that have been listed here so now.

C

um So the first thing is you pick an organization, so I told you like: this is like a walkthrough of of uh contributing to layer five. So the the first thing you do when, like you pick up uh a project or area with a particular repository on layer 5 is you go to the issue area? Now um you can see from this screenshot right. I made a screenshot of the issue area of this particular repository layer 5..

C

So the first thing you should do you go to the issue area to see the open issues you can see here that they're, like 36, open issues that are available, so you do expand and you search for the one you can contribute to you search for any of you pick up any of them. You can contribute to, and you make a comment on that the issue and someone in community gets it assigned to you and you go ahead and start fixing the issue. So why? Why we?

C

Why we stress on making a comment on the issue is because um we do not want. uh We do not want clashes when maybe, if you don't make a comment, someone else might have been working on the issue and you superior is coming and there'll be a clash right. So.

C

Please do well to when you click on an issue. You should read the comments and see if someone's assigned to it, but if no one is assigned to it make a comment and definitely we get it assigned to you. So, like I said it's going to be all practical, so we're going to be.

C

Going through one of the issues on one of the repositories and out this is like a walkthrough through um contributing and pushing your code back.

C

So give me a second okay, so uh so the repository I navigated to school buckets, so you can see yeah. So this is a scoop bucket. So, like I said the one of the first things you should do, you read about consume the readme of the project to understand what the project is about and all those other resources that were listed out right also that resources have been listed out right. So then, now, let's navigate to the issue era,.

C

Now, there's one open issue, which is this: uh adding a pull request templates so now this is an open issue, adding a pull request. Template now. One good thing about the five community. Is we make things very easy for you? I know like when I said contributing. Initially, I was really very marveled at how much the an issue would have like proper explanation like everything every resource you need to tackle. That issue will be given to you like it has a proper description below here.

C

So you see that this issue is about so the current behavior is. This repository is missing a template to present to contributors when they create, like a pr, a pull request. A pr means a pull request. So what this is about is okay. This repository doesn't have a pull request template so there's no there's no um information when a contributor creates a pr. So what is that behavior? That behavior is using this resource so there's a resource that has um remember. I said we have so many.

C

We have like up to 46 repositories, so one of our repositories here was referenced, uh the layer 5 repository. It has a pull request template this. Is it so? The issue says desired. Behavior here is using this resource as a template. You can simply copy this file, create a pull request, template dot md in the github folder of this repository.

C

So everything has been explained here on what you should do so, like I said, ella, please, whenever you, whenever you see an issue, please try to make a try to make a comment and it gets assigned to you well. This was self-assigned because this is like what I want to use for the practical session and the demonstration so yeah. Let's like go ahead so then, after after commenting and get assigned to you, the next thing you want to do is go ahead and start contributing, but, like I said, don't forget going through the contributing guidelines.

C

For me, I'm already familiar with the process, so I'm not going to be like using that document. So for you, that's a new comma! Please do. I would like to go through the contributing guidelines, so let's go ahead and start contributing, so I'm going to like open. I like opening stuff in youtube. So sorry, so I just opened this in a new tab. Let me stop this sorry, okay, so yeah.

C

So the next thing is the first thing you have to do right is to the repository, and please also remember that please start the repositories, as you contribute start your favorite repositories. You can see mine already started here, so you click on focus repository, and so this is process of the repository. So it's just going to take some seconds.

C

Okay, so um you see, I have successfully focused this repository, so the next uh step here is to clone it to your local device, your local system brother. So uh I have git bash open here, so I have to make this. Is this visible?

C

I need to make this yeah the git bash yeah, it's visible right, yes, okay, okay, sure so, uh like I said, the next step is to clone the repository. So you click on code.

C

Remember you're cloning, your forked copy and not the original one. This is what you're closing so you should. You should always be sure that you're cloning, the copy, so you uh click on this. It automatically copies. It then the first command. Let's go back to git bash, so git clone.

E

C

C

Okay, that's cool! So uh we successfully cloned the repository so I'll just cd into it.

C

Okay, so I'm using a windows operating system just so you know so uh cd into now the next. The next thing is we want to. If you open the uh contributing guideline, you see that you have, to like add the remote repository, so we want to add the remote repository, so we can be able to pull and merge changes when to our local updates like to update our own copy. So you have to add the remote repository and we are going to get the http address.

C

Is you have to navigate to the original to the original repository right? So this? So you see this is the original repository. I want to add the remote things like the motion, because you want to add it. So we click here and you copy that so yeah, so our gates, remote, add up stream.

C

So let me paste it: okay, okay, so uh now I've added remote so for you to. If you want to be sure, it's you've added that, so you can do a git, remote dash, v and yeah. So you see uh you see, the remote repository has been added right. So uh for you to for you to get changes, you can do a git spool and it gets merged. But right now it's it's! We just just walked the repository, so it's actually up to date.

C

If you after I do that, it should still show you that it's up to date, so the next thing is uh so with with working with git and github. You need to create branches. So it's necessary. You create branches where you want to work and you do not work on the master or it's not called the main branch. But you do not work directly into your own master branch. It's necessary that you create. um You create a branch that you would work with.

C

So if you are looking at the the the contributing guideline to create a branch, so we want to work on and specifically- and there are five has like they have like a suggestion for you to create better branches.

C

So uh it's it's better, like you're, creating with your name, slash the issue number most of the time or what's what's the issue is about? If you go through the contributing guidelines, you see you'd get more con context on that.

C

That's so um so, let's create a branch in your branch, git.

C

There's a shortcut actually the shortcut to actually create a branch and check out into that branch right, so you can do a git, checkouts dash b, then the name of the branch. So it's once it creates the branch it automatically checks out into that branch. So, like I said like like a better way to name your branches, just name it with the issue number.

C

So let me just get the issue number okay, so issue it. Okay, so just give me a sec so uh use. I prefer naming it like this. My name on slash issue.

C

Number eight, you can actually name it, but this this this way I feel it's. It goes straight to the point yeah, so uh you check out dashb and I've named the branch. So you see it's going to make a switch. So if you see it switched to the branch it switched here to the branch, so then uh we go ahead to make the changes so for I use I usually use. I use a vs code.

C

So that's the editor I'm going to be using to make this change so a command to open vs code from gitbash. It's called dots, so this like automatically opens vs code on git, bash and I'll just use account for it to open.

B

C

C

uh So having in mind will be sorry just give me a second.

C

Okay, yeah, okay, so remember: what's the um repository and what this issue rather is about is adding a pull request. Template file and desired behavior is creating a pull request, template file and adding it to the dot github folder of this repository.

C

So, let's open vs code. Sorry, I'm going to be navigating a lot uh okay, so we have the dots. Is this visible yep? It is oh sure, okay, so uh we have a dot, github, folder and remember the desired behavior was to create um a pull request: um template.md4m file on that dot, github under dispatch dot, github folder.

C

So we just sorry. Let me check exactly okay, so you under dispatch, you create a new file.

D

It's just not too long.

D

C

I think I already created it. Oh sorry, let me rename this okay.

C

C

C

Yeah, so uh this was this created under that github.

D

C

I created it wrongly, so let me do that again.

C

Okay, no, it should create under that.

C

Okay yeah, so uh this is under the path: um dot github. So uh what's the next thing is populating this with remember, there's a reference here. uh There was a reference on layer, 5 um repository so and applicator to that I'll. Just go ahead and copy.

C

This, let's just give me a second just copy this.

D

E

C

Sorry yeah, so it's uh okay! So now we created a pull request and template already. So this is like this. Is you can preview your changes here.

C

Right, okay, so that's good to go so now. We've made the changes. The next step is to push this back to github, so for vs code. Yes, code has like an indeed terminal, so you open this new terminal yeah so see it's already switched already into the um new branch we created.

C

So for you to check, be sure of the changes you made. You do a git status.

C

So you can see that the file we we created- you see it in red. So the next step is to add your changes. Add the changes you've made, so that's git add you could either call out the file or you do it, dots, which is add all you can either call out the file at all. So uh if you do it, it starts again. You see it changed to. It has been added. It signifies green here that shows that it has been added. So the next thing you want to do is commit your changes.

C

So now this is the point where most of the time we shall like have. Sometimes we have issues when people I I also I had issues with when I started like um when you want to. We have like a dem a dco check. What this you mean says, developer certificate of origin. That ensures that whoever is contributing is the person that signed off. You must always sign off your commits so when, when typing your commit message you have to when committing you have to sign it off, so you do it get that sign off.

C

C

Then the commit message so added full request: templates.

C

C

Okay, so uh you.

D

C

So get commit sorry for that.

C

Thanks treaty, delicious yeah.

C

F

I have a real quick question: are you in bash, so you could like hit the up arrow and go to the beginning of the line and and type in get committed.

A

Yeah, I think she is and yeah she can do that.

E

Okay, great yeah.

C

Oh sorry, I didn't get that.

A

uh So it's basically a shortcut, so if you have um used a command before you can just click on your upper arrow. Oh yeah, yeah, okay,.

C

Okay, no thanks yeah, so uh we've committed uh this change, so the next thing is.

G

Hey ruth a quick question.

C

G

Get get command that on dash dash sign off.

C

G

What what does it use for I mean.

C

Okay, so um it's a um it's a dchm developer certificate of origin, so it signs off your comments. Every commit you make it signs it off, like with your with your um details, your email and your your your name. So when we made the pr you'll see uh I'll, show you the how it signs it off like how it would look.

C

G

A

uh Sure, let me add one line here, so basically what it does is add your credentials to the comments. It's like a digital signature.

G

Signature: okay, yeah.

A

That's it. It basically adds your name and email id and, if needed, uh an ip address to your commits, which basically links back to you.

E

C

Okay, so um right um we've signed off the commits I'm committed. So next thing is pushing.

B

C

Minor thing that I would.

B

Like to add here, uh okay to sign off, you can also use a shorthand hyphen s. That's a shorthand.

C

B

G

C

Yes, cool, yeah, okay, so thanks everyone for all the additions so uh to to push the changes back to github.

C

You do a git push origin, then the the name of the branch- let's just copy this.

C

D

D

Just seven seconds.

C

C

Okay, so uh let's go back: let's navigate back to uh the repository and check it out so yeah. So you see uh we have pushed uh some changes, so you click on. Compare and pull requests.

C

E

So yeah after a batch terminal, one more time or okay, were you popping up there.

C

E

C

All right so, okay, okay, so um so I use uh so. You can see this right uh signed off by.

G

C

So we can write it.

G

Like uh by manually also, I guess, if we don't do that sign of option.

C

Yeah, if you don't do it and we have a particular check, um a github check that actually checks that. So, if you don't do it, the check wouldn't pass.

G

C

Yeah, okay, so um now we've um created now. The next thing is opening a pull request to the original repository, and usually um we on other repositories. We usually have the pull request template just that this one doesn't have so just in case you're, making a change- and you see it right up here. Please do well to fill in fill it in like usually it usually has this. This pr fixes. You put the issue number here.

C

You put the issue number here and if you have any notes for the viewers, you can put it underneath here and you tick this to say. Yes, I signed my commits and that's uh that's that let's go back to this okay, so um next thing is, you could just quickly write it. Let's just write it disappear, fixes.

C

D

C

Well, usually, on other repositories, you do you do not have to like write all this. It's already there, so this pair of is this okay, so we go ahead and click create request.

C

Yes, and we have successfully created a pull request in which a reviewer will be assigned, all people in the community will view the pr and if there are necessary changes, we usually make comments for you to ensure those changes and if you do not actually understand any implementation that has been asked, you can feel free to open. This slack channel feel free to like ask questions and a community member would definitely answer your questions.

C

So I think that's all. I would entertain any question.

A

Thank you for the tutorial. Both that was really helpful. um I'll, add two points here. If I may, um could you go back to your pr screen? Okay, please thank you. Did you scroll up all right, two quick points, one. If you have.

A

Picture this um after you've made a commit. You realize that you haven't signed off on it now. If you go forward with the peer, your sign of check wouldn't well, it won't pass so, instead of doing that, you can run a simple command which are typed up for you and send on the zoom chat, which will basically go back and sign off on your last comment.

A

If you want to.

A

Left that sentence back on all right. If you want to sign off on um comments that have that are going back or more than your last comment, you can use um a head eye option and which is basically a low scale. Rebasing of your comments and go back and amend your credit, so include the sign of option before pushing it towards appear that will help you reduce the amount of effort that will save you from the trouble or the embarrassment of that check, not passing through.

A

Another point to notice here is um when ruth um made that pair and included the line which says the spear fixes hash eight, what it basically does is it links back to the issue that was initially created to it. So when your peer is closed, that issue will automatically be linked and considered to be closed as well. This helps any reviewer or any uh passenger, buy, to confirm or to make sure that active issues and are converted into closed issues when they are done.

A

uh That's all from my side.

A

All right, um thank you so much for the tutorial truth. Please pardon my interruptions.

B

Any questions anybody, no! That's fine. Thanks for adding your infuse.

B

B

A

All right: well, that's it for the tutorial today. uh Thank you, andrew that's, legitly! All you need to make a contribution or to get started with kit.

C

I should can I stop sharing, oh yeah sure. Alright, thanks everyone.

G

Thanks ruth for the awesome tutorial.

A

Right um well before we move forward, let's honor our time, honored tradition and is anybody new in the call? If so, please go ahead and introduce yourself.

A

Soon, I think you're.

H

H

A

Hey gord: do you want to introduce yourself.

H

Yeah, I'm over I'm from new delhi, uh I'm doing uh engineering in electronics and communication, I'm in second year right now and I have joined this layer 5 community, to learn about things and open source. How can I contribute to it?

H

I'm just a beginner right now.

A

So great uh welcome to the community man we're all big ones here, uh not all, but let's just um we'll get, you started subway all right.

H

Yesterday, great.

A

All right moving on, uh I'm pretty sure I'm pronouncing this wrong, but uh radislav. Please do correct me for pronouncing your name wrong.

I

Yeah, it's it's correct hello. My name is francois frachu, I'm from bulgaria.

I

I actually um enter to the slack channel after the last cube conf to the player 5 community and, to be honest, I am really excited to um to learn new things and to try to help you with everything which I could and currently I'm working as a senior devops in cross.

I

Maybe this is not familiar for most of you guys and I'm currently working of the migration of their products to microservices and everything. That's related to microservices, kubernetes and dockers.

A

It's great radislav, um I'm actually, that is familiar to me, you're very welcome to the community. Here you should.

C

A

Join the vegetary debt meeting next wednesday.

I

Yeah I actually spoke with lee um and he um advised me to first came to the newcomer. I'm sorry that I late that I was on the other.

A

Meetings all right, we'll get you started in the community. Hopefully I will get you to the other meetings.

A

Thank you for the intro, moving on all right um in spirit of starting out the right way or whatever we want to stumble through and come to us, we'll be harassing you enough times that you stay anyway.

A

So um I have a little run-through of the last five side projects planned for you for anybody who wants to get into web development. So currently we have um just quickly. Yep uh is my screen visible?

A

G

A

All right, we currently have five live site projects going on. One of them is the central airport website, which is currently going under a massive transfer uh to a gatsby platform. The current site is grounded on japan platform and uses a basic framework.

A

We are in the process of transferring it or converting it into a next generation website which runs gatsby, and it's currently being built with react and strappy, and next chairs.

A

uh I won't be demoing that, because it's still a in progress project, but if anybody wants to check it out I'll put a link into the meeting minute, so you can go ahead and do that.

A

uh While I have you here, if you haven't already subscribed, please do go ahead and subscribe. You'll get all the links. You won't get all the resources you need to get started out.

A

Apart from that, you can also go ahead and check out all of our projects for anybody who wants to get involved in lecturing or the smi initiative, or the s p initiative or any of the programs that we have. Currently.

A

This would be the perfect place for you to start out for the national introduction post this jump onto a slack.

A

It really is the uh life and heart of life life. Any questions you have, you can post them on the general channel, it's a pretty forgiving community, so you're in good hands at any point of time.

A

Moving on uh the second website project that we're working on currently is the mystery dot. Io website meshi is one of the central projects under 5. It's the service management plan. I realized a lot of you might not know what those words mean.

A

Hopefully you will soon again. This is one of the perfect places to start out. This side is also run on jakail.

A

um If you're, looking to start out with mastery, another perfect place would be the documentation but more that later, because that's not a very interesting platform. Moving on another site that recently went under a major refurbishment is the sap project site. It still is up for grabs for anybody who wants to work on it, um contact prati, actually, who is only called today. I think if you want to work on this um or speak out now or signal on slack as you.

A

That is your call, uh we'll be harassing you enough times.

A

A

A

All right, those are the site projects I'll be adding links to the uh meeting minutes. So you can come back and check here.

A

Another good thing that we can make time for in this call is to point out areas that you can work with or that you can start out with at least for either activities participles or for newcomers.

A

These are some questions for you, so what you can do is you can pick a domain or an area that you're comfortable with- and you can add your name here in a comment or just in the talk or if you are shy of the public eye.

A

Please do signal on the slack we'll help you out either way so go ahead, pick out a domain that you're already comfortable with or that you want to get started out with and add your name here we will come back to you with project details or with corners of the project that you can help out with uh I'll point out a general community question: um are there any ui, ux designers in the call today or anybody looking to get into that area?

A

If so, please speak out, we have uh some work for you and an opportunity for you.

G

Hey, are you sure, so, I'm not looking out for like ui works, but like I wanted to get into that like? How does it really works? I mean they want to try it out like how how it is not like. I don't have any idea about it. So yeah, that's the same.

A

G

Never worked on design stuff before okay.

A

That's that's a good start, then um thank you for speaking out I'll, get you connected to uh either gerald or tony or someone and we'll get you started.

A

All right um for people who've joined in the last week or so do you have any issues anything that you want to discuss about? This is the perfect place to do so, no judgment. You can ask ask silly questions. You want. There are no silly questions actually.

F

I have uh probably a silly question: um should we be installing measuring on, or is this a work in process, uh or is it something I can install on my windows 10 pro.

A

For instagram, a big yes actually is not a working project. It's a product, that's rolled out and is soon going to be um originally parkings are being added to the cnc landscape.

A

If you want to know how to install machine safety, uh that is where the boring docks come into place.

F

Yes, yes, I'm I'm I've. uh I'm on that page.

A

Great, um can I ask which uh overstudent on what your system specifications are.

F

It's windows, 10 professional, completely patched. uh I've got visual studio code and visual studio and working in the cloud space.

A

That's perfect all right, uh there's a doc update coming, which is in tier at the moment, but these instructions should work as well.

F

Right yeah, I I think I am uh partially through this particular page uh yeah. Oh uh my uh curl didn't work because of a cash memory issue uh which I started researching on, because I have 32 gig of ram, but segwin doesn't has some issues.

A

And actually the lock failed to give you an answer there: uh a cash when ratio is not shouldn't actually be a problem with any decent amount of disk space.

F

I'll get through it, I I just thought I had uh the things that I had no.

A

Issues uh just ping and slack if you're not able to get into it.

E

Okay, thank you.

A

um All right anybody else, any issues that you want anything that you want to speak about.

A

You can also speak up if you want, um or if you haven't found a domain if working or any issues to work with we'll find you.

A

Some it can be a little hard to find issues or to find domains at the start, and you might get a stored, appliance slack or even on github or on email that you might hear. So please do speak up if you want to.

A

Also, yes, um thank you. Pratik. We had a message deaf meeting yesterday, which all of you are welcome to by the way again there's a meeting stable link here.

A

If and when you want to join us for meetings.

A

uh So the mystery def call is basically a weekly catch-up of the of any and all projects related to mystery in development stage, and we come together once a week and discuss things uh and related to the project and talk things too.

A

So on the last call, we had a tutorial session on how to run setup and run mesh tv cto metrics here is the cla for machine is the official cli and if you want to get started out with it, the last meeting recording would be the perfect place to go because you'll be up and running with the cli in about 10 minutes.

A

uh You'll find the recording on youtube in the next 24 hours. Hopefully again, you'll find a link to the recordings here.

A

I apologize for my voice if it's a little heavy. I have cold.

A

And well, that's all from my side for today. If anybody wants to speak up, please do go ahead or, if you're, just tired of hearing my voice, that's completely understandable. Please go.

A

A

All right, then, um I will end this reading with a request for you to fill out this.

A

Actually, uh the same questionnaire is available on the side as well. So please do go ahead and fill out this questionnaire with any tutorials that you want for the next meeting and we'll get set up.

A

A

Thanks for joining in everybody, that's it for today see you next week.

C

C

A

A

A