GitHub GitHub Checkout, 28 Jun 2021

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Get started with GitHub issue forms - GitHub Checkout

Description

With YAML configured issue forms, you can create templates that have customizable structured forms with required fields and easy-to-follow steps, encouraging contributors to capture every important detail.

Blog: https://github.blog/changelog/2021-06-23-issues-forms-beta-for-public-repositories/

As always, feel free to leave us a comment below and don't forget to subscribe: http://bit.ly/subgithub

Thanks!

Connect with us.
Facebook: http://fb.com/github
Twitter: http://twitter.com/github
LinkedIn: http://linkedin.com/company/github

About GitHub
GitHub is the best place to share code with friends, co-workers, classmates, and complete strangers. Millions of people use GitHub to build amazing things together. For more info, go to http://github.com

A

Hey folks, anisha here and I've got to get a feature for you to check out so if you've been following along the github changelog quest, you've seen all of the features that we've shipped recently and let me tell you- we've been shipping a ton of features recently, but for these checkout videos we'll be hearing more from the folks that have actually built these features and see a demo of them too. So today, I've got megan here, who's going to be telling us all about issue forms megan over to you.

A

B

Yeah, my name is megan o'neill and I am a senior software engineer in the communities department at github. So I'm going to tell you all about issue forms. I am super excited about them and it really is kind of what it sounds like. It's basically a form experience for filling out issues. So previously, when you'd go to create an issue, you just get this blank uh wysiwyg box or if somebody was using markdown templates. Maybe there would be some mark down in there with a couple questions here when you actually go and navigate to it.

B

You'll get a full-fledged form, so think check boxes, drop, downs, multiple wysiwygs, so really enabling folks to get the information that they're looking for. So let's jump into actually building one so over here, you'll notice that we're just in just a demo repo and we are going to store these templates right inside of the dot github folder inside of the issue- template folder in there and then here is the actual name of our issue form. So it's important to note that it ends in yaml, because we build issue forms with yaml syntax.

B

So, let's build out our bug report a little bit more you'll, see on the side here that we actually have some docs just as far as what are the different inputs that we can use and an example for each. I really love the examples because I totally rely on them for actually building out my issue forms.

B

So, let's see what do we have in our bug report right now we have some markdown. We have a text area, but maybe we want to add a drop down to actually ask folks like. Where are you seeing this issue? Maybe it's the web? Maybe it's an api, um maybe it's mobile, so let's scroll down in our docs until we get to a drop down.

B

So let's copy this on over and the really nice part about this is that when you do copy it, it maintains the spacing and since we're using yaml, the spacing is actually super important. So we'll ask: where did you see this issue and we'll check in on? Maybe it's the web?

B

Maybe it's an api um and we'll even say hey. Maybe it's mobile, we'll get this out of here. So you'll notice that we have this validations required down here and that just means that folks actually have to fill out this field in order to submit the issue. So this is all looking pretty good. Let's do a quick commit.

B

And now let's actually go and fill out one of these issues to see what does an issue form look like from the user side. You'll see here that we have our bug report. So let's go and fill it out, and here you actually have the issue form so you'll see that we have this little asterisk here, which denotes that the field is required and then the same thing for our drop-down. So in order for me to actually fill out this form and submit it, um we have to tell somebody what happened it crashed.

B

Oh, no. Hopefully your forms and your answers are a little bit better than this, and so where did we see this so we'll see we could do the web? uh Maybe the api, great and now you've filled out your first issue form and it's submitted, and it looks exactly like any other issue now.

A

Wow megan, I absolutely loved it. I loved everything that you just showed. This is amazing. I just can't believe how easy you know. Issue forms is going to make everyone's lives, especially. I love the docs that you could literally just copy and paste it and then just tweak the bits it just. It just makes everyone's life so much more easier. So I've got a couple questions for you, then, um who do you think issue? Forms is really going to be helping out the most yeah.

B

We are super excited about maintainers using issue forms right. It is vital that maintainers get the information that they need to. Actually, you know, fix a bug or get a feature request, and all too often it's really easy to you know if you're using a markdown template, say accidentally, delete a question or miss a question that was in there. So I think this really enables maintainers to collect the information that they need, whether it's an api version in a drop-down, um a code sample or some check boxes. um I think really.

B

The big thing too is having required fields so that they're getting higher quality issues submitted yeah.

A

Definitely for sure- um and then I know a lot of folks are using markdown right now and do you have any tips for folks? Switching from markdown templates to issue forms totally.

B

Yeah, so you know, as mentioned previously, we are using yaml, so the spacing is super important. Most of the issues that we've seen with you know, templates being invalid, are really just issues with spacing so like every time just just copy the example. That's what I do like no shame there.

B

Also, if there's a nested label, make sure that it does stay nested, because that's also super important and there will be like an error banner that appears at the top of the screen once you commit. If something is wrong, so totally check that out.

B

You know if it says something like labels is invalid and you know that that's a required key. It's probably because there's an extra s somewhere um so follow the trail of errors and just use the docs totally, and you should be totally fine.

A

Great, I love it and I especially love the the fact that you know everything's in the docs and you can literally just copy and paste it and tweak it and there you have it anything to make everyone's lives easier right. So so folks uh go ahead and check out um issue forms and let us know what you think about it. You can drop your comments down below hit us up on twitter or even just leave your feedback on support community as well.

A

So thanks again, megan and folks stay tuned for more check out videos coming your way very soon.