GitHub's form schema that uses YAML instead of markdown is currently in beta. These new YAML Issue GitHub's form schema have a lot of major benefits that this repository could benefit from:
Advantages over traditional Markdown Issue forms?
Necessary Required fields: The required: true marked fields cannot be ignored and will make the user require to fill out the field, select an option or similar before they can submit an issue.
Better Interactive design: With new dropdown menu, input fields, render text blocks, and checkbox selection.
Codeblock rendering for contributor-submitted text: Maintainers commonly ask contributors to copy and paste log output, or include relevant code samples. The textarea input can be configured to automatically process contributor-submitted text into a codeblock by including the attribute render.
Always the same structure: The content created by the issue form will always be in the same structure.
Easier filling out: There are a few QOL changes compared to templates. As an example will you not need to change [ ] to [x] in checkboxes but can instead just click the checkbox itself to (un)tick it. When a contributor fills out an issue form, their responses for each input are converted to markdown and added to the body of an issue.
Comments: You can have simple markdown areas which are displayed as text in the form. This is useful to provide info instead of using the HTML comment tag.
GitHub's form schema for those who don't know are essentially enhanced Issue templates, allowing more freedom in designing issue templates. There is a page providing some info about the new GitHub's form schema issue forms: https://gh-community.github.io/issue-template-feedback/structured/
Brief Description
GitHub's form schema that uses YAML instead of markdown is currently in beta. These new YAML Issue GitHub's form schema have a lot of major benefits that this repository could benefit from:
Advantages over traditional Markdown Issue forms?
required: truemarked fields cannot be ignored and will make the user require to fill out the field, select an option or similar before they can submit an issue.For more information see: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
Context
GitHub's form schema for those who don't know are essentially enhanced Issue templates, allowing more freedom in designing issue templates. There is a page providing some info about the new GitHub's form schema issue forms: https://gh-community.github.io/issue-template-feedback/structured/
Any Other Important Information
None yet.