DFFML Rolling Alice: Coach Alice, 31 Aug 2022

Previous Meeting

Next Meeting

⏯

youtube image

►

From YouTube: Our Open Source Guide: How to help Alice contribute additional Recommended Community Standards

Description

Tutorial: https://github.com/intel/dffml/blob/alice/docs/tutorials/rolling_alice/0001_coach_alice/0002_our_open_source_guide.md
This is a clip from: Rolling Alice: 2022 Progress Reports: July Activities Recap: https://www.youtube.com/watch?v=JDh2DARl8os&list=PLtzAOVTpO2jYt71umwc-ze6OmwwCIMnLw&index=7&t=10s

A

If we were to look at my project right now, it has the test py file in it right. Okay, so now we're going to ask uh now we're going to have alice um contribute. Actually we can have alice. We can run the command first and we'll see. Okay, so alice is going to contribute for us, um the readme and uh community standards right.

A

So here's the contributor, sorry she's, going to contribute the contributing file and the readme okay, great so, um and I'm going to go ahead and run this command down here in the debugging to go ahead and delete both of those four requests now because we're going to do another thing so now, what we're going to do is we're going to extend alice right, so we're going to have alice, contribute the code of conduct file all right.

A

So then we basically just do our find or replace um on that file, so we copy from an existing overlay. So from the readme overlay we do a find, replace we find and replace everything, that's readme in the various title, fully uppercase or lowercase and code of conduct, and then we go ahead and we add the overlay code of conduct to the list of installed overlays when recommended community standards is run right. So anytime the recommended community standards flow is executed and the install overlays are not overwritten.

A

Then we'll see code of conduct loaded from the code of conduct file. Okay. So uh then this is just showing us that and then we need to add.

A

So we also need to add, um through the um entry points file the definition of the um overlays, which should be applied to the code of conduct below itself right and so those are overly getting overly github to help it figure out some branches and stuff, and so that code is in there and you should take a look at that code right. So you should take a look at the code in alice. Please contribute recommended community standards, that's basically where all the code lives.

A

So at this point now we can run the reinstall on alice and we can ask her to contribute the recommended community standards again. So now we need to be aware that she is operating as our account right now, um so when you're using gh actually she's signed in as you right. So let's see what are the pull requests saying so code of conduct? Okay, look at that all right and then the readme okay.

A

So here is the code of conduct md, all right, so now we could go and we could change those files. So if we wanted to, we could go in here right and go to conducts contents right. So we could say.

A

Code of conduct right, so let's just move.

A

Okay and now we can.

A

Close those off again, we can write it again and we should see that the code of conducts the contents of that code of conduct- that's being contributed, has changed all right so and then the contributing uh the alice contribution. Docs um here so come on.

A

Oh yeah, that's right, github is being slow. We got a few seconds of goodness. Okay, so this is running, create contributing.

A

This is stuck on here. It's probably stuck on some github operations in progress, um okay, so this then in the contributing docs themselves. It goes over. Writing, uh oh, like just random little overlays, and so uh this is, like you know, hey. If I wanted to read from a config file, how would I do that right? So you could then okay. So let's go check out our pull requests go to conduct all right.

A

So now we see it says, code of conduct, okay and so there's other stuff that you can do where you can add inputs, one off.

A

A

Repose, okay, so this doesn't support adding overlays as one offs yeah. You have to install them. Okay, um all right, okay, so that's great, so that is our alisar open source guide right. So now we can also list here just to see okay yep there they are sweet. Okay, so there's our contribution. So now you can extend alice. You know, following this methodology to to contribute arbitrary files right, and so you can also, you know, maybe inspect the context, the contents or look at auxiliary sources of information uh by following similar.

A

You know this writing operations within the contributing and then going beyond that. There's also, you know the should I and and the metastatic analysis tutorial where we talk about. uh Writing should I, which is the stuff that's currently used in just the scraping without the proactive contribution and then there's the extension of. Should I, which talks about overlays a little more.