Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Proposal]: Use new GitHub's form schema for Issue forms #319

Closed
abhiTronix opened this issue Jul 4, 2022 · 1 comment · Fixed by #320 or #321
Closed

[Proposal]: Use new GitHub's form schema for Issue forms #319

abhiTronix opened this issue Jul 4, 2022 · 1 comment · Fixed by #320 or #321
Assignees
Labels
ENHANCEMENT ⚡ New Feature/Addition/Improvement PROPOSAL 📩 A proposal/proposition SOLVED 🏁 This issue/PR is resolved now. Goal Achieved!
Milestone

Comments

@abhiTronix
Copy link
Owner

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?

  • 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.

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

Screenshot of new Bug Report form:
image

@abhiTronix abhiTronix added ENHANCEMENT ⚡ New Feature/Addition/Improvement WORK IN PROGRESS 🚧 currently been worked on. PROPOSAL 📩 A proposal/proposition labels Jul 4, 2022
@abhiTronix abhiTronix added this to the 0.2.6 milestone Jul 4, 2022
@abhiTronix abhiTronix self-assigned this Jul 4, 2022
@abhiTronix abhiTronix added this to To do in VidGear v0.2.6 via automation Jul 4, 2022
@abhiTronix abhiTronix moved this from To do to In progress in VidGear v0.2.6 Jul 4, 2022
@abhiTronix abhiTronix linked a pull request Jul 4, 2022 that will close this issue
6 tasks
abhiTronix added a commit that referenced this issue Jul 5, 2022
…ixed #319)

- ✨ Added new `bug_report.yaml`
- ✨ Added new `question.yaml`
- ✨ Added new `proposal.yaml`
- 🔥 Deleted `bug_report.md`
- 🔥 Deleted `question.md`
- 🔥 Deleted `proposal.md`
- 🎨 Polished forms.
- ✏️ Fixed typos in forms and its context.
@abhiTronix
Copy link
Owner Author

Successfully resolved and merged in commit 0aeb00d

VidGear v0.2.6 automation moved this from In progress to Done Jul 5, 2022
@abhiTronix abhiTronix added SOLVED 🏁 This issue/PR is resolved now. Goal Achieved! and removed WORK IN PROGRESS 🚧 currently been worked on. labels Jul 5, 2022
@abhiTronix abhiTronix linked a pull request Jul 5, 2022 that will close this issue
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ENHANCEMENT ⚡ New Feature/Addition/Improvement PROPOSAL 📩 A proposal/proposition SOLVED 🏁 This issue/PR is resolved now. Goal Achieved!
Projects
No open projects
1 participant