New bug report form

[ybiquitous]

Which issue, if any, is this issue related to?

• The first step of Use YAML for GitHub Issue templates #5

Is there anything in the PR that needs further explanation?

The new form is based on:
https://github.com/stylelint/stylelint/blob/2dbcf152f79fddba3e312c785c7ba88951534ce6/.github/ISSUE_TEMPLATE/REPORT_A_BUG.md
https://github.com/stylelint/.github/blob/69529998a0d53ce898f95d02ca6d7c81b3a57206/.github/ISSUE_TEMPLATE/REPORT_A_BUG.md

See the GitHub documentation:
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests

Any feedback is welcome! 😄

(Also, thanks to the prior work of @adalinesimonian!)

[jeddy3]

@ybiquitous Thanks for getting the ball rolling with this!

I forgot (when I transferred the issue over) that the templates here are meant to be generic as they are applied to all the repos that don't have their own templates.

Let's do the generic templates first, then write more specific ones for the stylelint/stylelint repo based on those.

So, let's:

• store what you've written here
• strip this template back to match the content of the generic template we have at the moment (as, for example, a lot of the questions are irrelevant if reporting a bug with the website)

I suggest moving the "(e.g. what warnings or errors did you get)?" of the last question into the "description" field.

[ybiquitous]

@jeddy3 Thanks for the feedback! I've addressed the reviews, so please check again. 😃

[jeddy3]

Thanks for making the changes. Almost there.

I've made 2 suggestions.

GitHub is complaining about:

title must be of type String and cannot be empty. Learn more.
body[1]: description must be of type String and cannot be empty. Learn more.
body[1]: placeholder must be of type String and cannot be empty. Learn more.
body[2]: description must be of type String and cannot be empty. Learn more.
body[2]: placeholder must be of type String and cannot be empty. Learn more.
body[3]: description must be of type String and cannot be empty. Learn more.
body[3]: placeholder must be of type String and cannot be empty. Learn more.
body[4]: description must be of type String and cannot be empty. Learn more.
body[4]: placeholder must be of type String and cannot be empty. Learn more.
Body must contain at least one non-markdown field. Learn more.

For the title and body[x] I think we simply need to remove the fields rather than have an empty string as they're optional.

For Body, I think we need to move the indentation in a level before it:

body
- type markdown
..

[jeddy3]

Incidentally, is there any way to preview what this will look like?

[ybiquitous]

Thanks, I'll fix them soon!

GitHub is complaining about:

BTW, what checker are you using?

[ybiquitous]

Incidentally, is there any way to preview what this will look like?

I'll create a test repo. 💪🏼

[jeddy3]

BTW, what checker are you using?

Just clicking on view file. It shows the warnings on the next page.

[jeddy3]

I'll create a test repo. 💪🏼

Oh, no need now. It renders now that the validation warnings are fixed.

[ybiquitous]

Oh, no need now. It renders now that the validation warnings are fixed.

Ah, I've created it. 😅
Try https://github.com/ybiquitous/issue-form-example/issues/new/choose if OK.

I'll remove the test repo after the merge.

[ybiquitous]

@jeddy3 All done!

[jeddy3]

One last request, otherwise LGTM.

---

As an aside, it's a shame the rendered form is littered with red asterisks. The UK GOV has good research that those aren't great for user experience, and recommends putting "(optional)" after optional fields instead.

It's a minor compliant as the form is significantly better than our current approach.

[ybiquitous]

Now it's pretty simple. Nice. 👍🏼

https://github.com/ybiquitous/issue-form-example/issues/new?assignees=&labels=&template=REPORT_A_BUG.yml

[jeddy3]

Looks great, thanks!

[ybiquitous]

Thanks for the review! Feel free to merge! 😊

[ybiquitous]

Next step, I'll create the remaining issue forms. 💪🏼