Convert issue templates into issue forms #6543
Conversation
pierlon
added
the
Project Management
| - type: dropdown | ||
| attributes: | ||
| label: AMP plugin template mode | ||
| description: Specify which template mode the bug occurs on. | ||
| options: | ||
| - Standard | ||
| - Transitional | ||
| - Reader | ||
| validations: | ||
| required: true |
There was a problem hiding this comment.
The issue could occur on all template modes. Maybe this should be checkboxes instead? Or there could be an all option? Maybe it shouldn't be required.
There was a problem hiding this comment.
The dropdown input has a multiple attribute that allows for the user to select multiple options, which I think would work.
| - Bug | ||
|
|
||
| body: | ||
| - type: textarea |
There was a problem hiding this comment.
| - type: textarea | |
| - type: markdown |
There was a problem hiding this comment.
I also first thought of markdown when configuring this, but the docs state it's only used for display:
You can use a markdown element to display Markdown in your form that provides extra context to the user, but is not submitted.
Actually, when you click on a textarea input, it transforms into a markdown input:
textarea.mp4
See the demo at https://github.com/pierlon/amp-wp/issues/new?assignees=&labels=Bug&template=bug_report.yml
There was a problem hiding this comment.
Oh, I had assumed that textarea was for unformatted text.
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea |
There was a problem hiding this comment.
| - type: textarea | |
| - type: markdown |
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea |
There was a problem hiding this comment.
| - type: textarea | |
| - type: markdown |
| --- | ||
| _**Do not alter anything below. The following fields will be managed by moderators only.**_ | ||
|
|
||
| - type: textarea |
There was a problem hiding this comment.
| - type: textarea | |
| - type: markdown |
| --- | ||
| _**Do not alter anything below. The following fields will be managed by moderators only.**_ | ||
|
|
||
| - type: textarea |
There was a problem hiding this comment.
| - type: textarea | |
| - type: markdown |
| label: Acceptance Criteria | ||
| description: One or more bullet points for acceptance criteria. | ||
|
|
||
| - type: textarea |
There was a problem hiding this comment.
| - type: textarea | |
| - type: markdown |
| One or more bullet points for how to technically resolve the issue. For significant Implementation Design, | ||
| it is ok use a Google document **accessible by anyone**. | ||
|
|
||
| - type: textarea |
There was a problem hiding this comment.
| - type: textarea | |
| - type: markdown |
| label: QA Testing Instructions | ||
| description: One or more bullet points to describe how to test the implementation in QA. | ||
|
|
||
| - type: textarea |
There was a problem hiding this comment.
| - type: textarea | |
| - type: markdown |
| label: Demo | ||
| description: A video or screenshots demoing the implementation. | ||
|
|
||
| - type: textarea |
There was a problem hiding this comment.
| - type: textarea | |
| - type: markdown |
Co-authored-by: Weston Ruter <[email protected]>
westonruter
added
the
Changelogged
Summary
GitHub now has a feature to allow us to build structured issue forms with required fields and easy-to-follow steps. This PR utilizes this new feature by converting our "bug" and "feature request" issue templates into issue forms.
Most notable changes about the "bug" issue form:
The "Additional context" section has been split into separate inputs to allow for better capture of information
A "Site Health" input has been added to capture Site Health information
Checklist