Google Season of Docs - Microtasks

[Nebrethar]

Google Season of Docs - Microtasks

Project overview

The CHAOSS Diversity and Inclusion Badging Program began as a way to ensure that D&I metrics can have a significant impact on the ways that communities function. The aim of the CHAOSS D&I Badging program is to bring D&I metrics into use for propelling good D&I practices in different open source systems.

This project will focus on framing documentation for the D&I Badging program and aligning it in such a way that it makes sense after translation. This work would focus on more community-facing docs related to Badging and also on existing Markdown files.

Submitting microtasks

All microtasks must be submitted as a response to this issue.

Once you submit your first microtask, your responses will be recorded in a document on hackmd.io. These documents will be regularly updated, and some formats may be changed to unify the documents. Your submission's hackmd document may be found at the bottom of this post.

After a period of about a week, our project mentors (@Nebrethar @bistaastha) will comment on the document with advice and direction.

Microtask 0:

Q 0 Review JOSS documentation on submission and review and see how it is related to the current workflow.

The Journal of Open Source Software is one of the primary references used for building out the CHAOSS Badging process. The goal is to compare how the current process works in comparison to the review process of JOSS.

Reference:

• Joss Documentation

Q 1 Review the Core Infrastructure Initiative self-report badging system on projects and events and report schematic differences.

Projects and events are very different, but how different are they in our program? List one thing you would change about either, or both.

Reference:

• CII home page
• Sample CII badge and criteria

Microtask 1:

Q 0 Submit a non-existent project to understand the workflow.

Create a draft PR after adding a mock event in either the Project Badging or Event Badging repository. Record your observations as a part of the microtask.

Reference:

• Project Badging
• Event Badging

Q 1 Review a mock event created by someone else.

If available, take the time to review an event that someone else has posted. If no fake events have been posted yet for this session, use one of the mock events from this year's Google Summer of Code application session:

• Add Mock event 3 event-diversity-and-inclusion#1
• apply for an event badge diversity-and-inclusion#2

These are great mock events, but we recommend using a fake event submitted for GSoD, if available.

Microtask 2:

Q 0 Provide a brief summary of the submission and review process.

After reviewing the workflow process and all of the moving parts that create it, provide your idea of how this workflow can be best explained. This task is is focused to the submission and review workflow of the Badging Program.

Concise answers are appreciated, but provide as much detail as you want!

Current Submissions

tharun143
JackieBinya
xiaoya-Esther

[JackieBinya]

Hello @Nebrethar
I have a few questions with regards to these GSOD 2020-Microstasks listed above. I will admit I am quite a noob when it comes to this process of creating content for a technical writeup.

From what I have gathered the goal is clearly defined, Create documentation for the D&I Badging project. The microtasks then breakdown the monolithic task of creating the documentation at one go to well-defined microtasks which can be completed individually. My guess is these microtasks will be recomposed later to make the actual documentation.

Now as a contributor I appreciate the benefit of the microtasks already although I don't fully grasp the concept and process, by just going through the microtasks it has given me perspective and insight on the executable goals of the project.

Now my questions are:

• You mention that All microtasks must be submitted as a response to this issue.
  Do I make a submission via a PR?
• Do I complete all microtasks or I choose one or two which may appeal to me?
• Microtask 0 Q0 requires that we Review JOSS documentation on submission and review and see how it is related to the current workflow
  May I please have a link to a resource with the CHAOSS D&I Badging's current workflow.

Thanks in advance 😊

[Nebrethar]

Hi @JackieBinya and welcome to our microtasks! I am glad you are interested in our project. Here are my answers:

1. I admit this is a rather vague statement 😅 I will fix now. Basically just submit your answers to the microtasks as a comment on this issue, like you just did to ask questions.
2. You complete all microtasks, but don't consider it like you would a test! It's mostly so that you can become familiar with our project and the ideas it came from.
3. All the current workflow spans all of the @badging organization, but the submission and review (the most important parts) are in project and event repositories for diversity and inclusion.

I appreciate that you have asked questions! Let me know if you have any more 😁

[JackieBinya]

Awesome @Nebrethar. I totally get it now 🙂.

[tharun143]

@Nebrethar Regarding the Q1 in Microtask 1

Review the CII self-report system on projects and events and report schematic differences.

Can I get the resource for CII self-report system?

Thanks in Advance.

Stay Safe and stay healthy 😄

[Nebrethar]

@tharun143

Can I get the resource for CII self-report system?

Thanks for noticing this! It somehow didnt make it into this issue. I have added references for Core Infrastructure Initiative's badging program.

[tharun143]

@Nebrethar

It somehow didn't make it into this issue.

So, Is Q1 part of this issue or not?

[Nebrethar]

@tharun143

So, Is Q1 part of this issue or not?

Q1 of Microtask 0 is the area that I updated in response to your questions 😁 It contains the relevant CII links and a little more information now.

[bistaastha]

@JackieBinya @tharun143 Your microtask solutions look awesome!

@Nebrethar and I will be available for discussing your work and answering other questions about CHAOSS Badging during GSoD office hours(#26).

[xiaoya-yaya]

Hi, @Nebrethar I hope you are doing well.
I'm working on my Microtask 1

Q 0 Submit a non-existent project to understand the workflow.

I have opened a draft pr, it's for the first step wrote in the document -- to append an entry in the table, and when I prepared to merge the pr, I found a conversation template to answer the detailed questions in step 2 was already created for me, so I finished it and the process looks like to provide detailed D&I information in the pr description.

So, does this basically the whole procedure or do I need to open another pr and work on the PR template md file?

[xiaoya-yaya]

I have reviewed a mock project as a part of Microtask-1 Q1 submitted by @xiaoya-Esther 😄

Mock project

Everything was clearly described and the answers met the requirements. The answers were done in a complete precise manner. A badge of silver could be awarded to the mock project.

Thank you @tharun143 for your kind review! 😄

[tharun143]

Thank you @tharun143 for your kind review! 😄

Feel free to review my PR as a part of microtask 😄 @xiaoya-Esther

[JackieBinya]

Hello everyone Is office hours in session yet, as in now? I am failing to join 😔

…

On Thu, 11 Jun 2020, 15:03 Esther, ***@***.***> wrote: Microtask 1 Q 0 Submit a non-existent project to understand the workflow. A 0 Below is the mock project I submitted Microtsak 1 Q0 <badging/project-diversity-and-inclusion#1> *Part of the observation are described in the comment above:* I have opened a draft pr, it's for the first step wrote in the document -- to append an entry in the table, and when I prepared to merge the pr, I found a conversation template to answer the detailed questions in step 2 was already created for me, so I finished it and the process looks like to provide detailed D&I information in the pr description. *And here are some other observations:* - Firstly, I clicked on the project badging homepage <https://github.com/badging/project-diversity-and-inclusion>, it is precisely described on how to apply a badge. But as I described in the patch <badging/project-diversity-and-inclusion#3> I think the README.md exists ambiguous descriptions on instructions, I have submitted a PR <badging/project-diversity-and-inclusion#3> to this. > The descriptions above and below the table seem like the same meaning but refer to different things, it's a little ambiguous, so I changed the first sentence into a different expression - The Pull Request template is in clear layout and each question is well described and easily understood, I also find the reference of each related CHAOSS metric are provided in a CHAOSS-metrics.md file, though it is not so difficult to seek out, I think it will be better to mention it somewhere in the document. - There is a table at the front of the PR template for basic information collecting purpose, I think it’s clear. But I have a confusion about what the “labels” stands for, I assume it represents whether this badge application is for a project or an event, but it wrote “event“ in a project PR template, so now I’m not really sure what this means. - Another proposition is to enrich the PR template with more D&I metrics, as I mentioned in Microtask 0 Q 1 <#25 (comment)> - The last observation is also a confusion from above <#25 (comment)>, > So, does this basically the whole procedure, or do I need to open another pr and work on the PR template md file I guess I submit the PR in the right way, so from my view, the present document does not totally match the workflow, since we don’t have to submit another PR for detailed questions. Maybe this part of the doc should be reorganized. In conclusion, I understand the project is in the beginning state, some of the observations above can be easily solved once the workflow is built out, and the documentation can be well structured and navigated. I’m so looking forward to perfecting these with you guys! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#25 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AL7QJD56WI6VRFODKGWCGYDRWDI3JANCNFSM4NTBCFVQ> .

[Nebrethar]

Hi @JackieBinya, The office hours are on for the next 50 minutes and the link is:

https://meet.google.com/rip-zkbs-biy

[JackieBinya]

@Nebrethar and @bistaastha
May I please have the links you shared during the meeting.

Thanks.

[tharun143]

@JackieBinya

https://hackmd.io/@7f7uN_UHRtOhM5rnON3_HQ/H1NFDGn2L
https://docs.google.com/document/d/1WrY4PjOrC_Fp6aiWFjfRRZuujlolSraUlTAJHPfbw9I/edit
https://docs.google.com/document/d/1p52ngmP_6CntBIu969VtQO2fPirAwKrjO2TAUo2jRHs/edit#

[JackieBinya]

Thanks @tharun143....

[Nebrethar]

It was nice to get to know you all on the GSoD Office Hours call!

@xiaoya-Esther brings up a good point:

All my Microtasks are finished🎉🎉, this issue is getting extraordinary long, I think I might open another issue to hold all my microtasks, which will make it more intuitive.

I think it's important that we have a public doc where we can leave comments. Here are the current docs now on HackMD:

Tharun
Jackie
Xiaoya

I will be reviewing and leaving comments early next week. I have to get to an exam but I will leave more details of the microtask workflow later :)

Thank you!

[xiaoya-yaya]

I think it's important that we have a public doc where we can leave comments. Here are the current docs now on HackMD:

Tharun
Jackie
Xiaoya

Awesome @Nebrethar, this is better:)

[JackieBinya]

@Nebrethar, @bistaastha and @community

I have made updates to my microtasks and I am happy to announce that they are complete, may you please kindly review them.

@Nebrethar I was not sure on which platform I was supposed to submit my updates . I finally settled on GitHub so that my work is consistent with everyone else's.
Please advise am I supposed to also push my updates to hackmd.io ?

Thanks in advance...

[Nebrethar]

@JackieBinya Thanks for submitting your microtasks! Your updates have been added to your hackmd document.

@bistaastha and I plan to review all microtasks on hackmd (adding comments) over the next three days. I also updated the main post with these guidelines. Thank you for asking; it got me moving again!

[JackieBinya]

Hello D&I Badging Community I would like to excuse myself from today's office hours. Despite my wishes I unfortunately could not attend the meeting. I have a WiFi outage😔. I have been refreshing my browser to no avail for the past 30min. I am honestly gutted. I am looking foward to catching up on the minutes. Regards...

…

On Tue, 16 Jun 2020, 16:09 Matt Snell, ***@***.***> wrote: @JackieBinya <https://github.com/JackieBinya> Thanks for submitting your microtasks! Your updates have been added to your hackmd document ***@***.***/JackieBinya>. @bistaastha <https://github.com/bistaastha> and I plan to review all microtasks with comments on hackmd over the next three days. I also updated the main post with these guidelines. Thank you for asking; it got me moving again! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#25 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AL7QJD6POMU7KC6L6HCYNJLRW54IPANCNFSM4NTBCFVQ> .

[Nebrethar]

@JackieBinya I appreciate that you mentioned what was going on. I also happen to be having internet issues at home! 😢 See you around. Also, I have an announcement coming up...

[Nebrethar]

I have left comments all of your microtask submissions on HackMD!

Tharun
Jackie
Xiaoya

Let me know if you have any questions or comments!!! 👍
Still awaiting reviews from Aastha, but they will be here!

@xiaoya-Esther @JackieBinya @tharun143
@bistaastha

[JackieBinya]

Hello @bistaastha and @Nebrethar and @community

@Nebrethar and @bistaastha please review my updated proposal for the new D&I Badging Documentation in this link

@Nebrethar I opened an issue on tagging D&I Badges with release year information as you had advised.

I had almost forgotten, I wrote a blog post about life, the lessons I had learnt about CHAOSS and the D&I Project and finally why I think the D&I project is great.
If anyone is interested in that sort of thing please do read and let me know what you think.
🌻

[JackieBinya]

Hello I just wanted to find out if the Office Hours was in session yet?
And just to find out is it a weekly event.

[xiaoya-yaya]

Hi @JackieBinya the link is here https://meet.google.com/eot-jikt-for