chore: add issue template form #1913
Conversation
There was a problem hiding this comment.
I see there's a new Issue Form feature, might worth consider in a future iteration on that
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms
It is very powerful in compare to the markdown
| name: Feature request | ||
| about: Suggest an idea | ||
| title: '' | ||
| labels: '' |
There was a problem hiding this comment.
add a suitable label maybe so we can filter?
| --- | ||
| name: Feature request | ||
| about: Suggest an idea | ||
| title: '' |
There was a problem hiding this comment.
| title: '' | |
| title: ''[Feature]: " |
maybe something like this
.github/ISSUE_TEMPLATE/bug_report.md
Outdated
| --- | ||
| name: Bug report | ||
| about: Create a bug report | ||
| title: '' |
There was a problem hiding this comment.
| title: '' | |
| title: ''[Bug]: " |
here also, maybe something like this
.github/ISSUE_TEMPLATE/bug_report.md
Outdated
| Browser, operating system | ||
|
|
||
| **Reproducible Example** | ||
| Please provide a simple minimal example that reproduces the issue. Use this [StackBlitz](https://stackblitz.com/edit/vibe-bug-report) or anything similar. |
.github/ISSUE_TEMPLATE/bug_report.md
Outdated
| If applicable, add screenshots or a video to help explain your problem. | ||
|
|
||
| **Package Version** | ||
| e.g. 2.84.0 |
There was a problem hiding this comment.
I'm being picky here, sorry, but for consistency: you ended the other sentences with a dot, so maybe worth here also
| e.g. 2.84.0 | |
| e.g. 2.84.0 . |
.github/ISSUE_TEMPLATE/bug_report.md
Outdated
| e.g. 2.84.0 | ||
|
|
||
| **System Info** | ||
| Browser, operating system |
There was a problem hiding this comment.
I'm being picky here, sorry, but for consistency: you ended the other sentences with a dot, so maybe worth here also
| Browser, operating system | |
| Browser, operating system. |
| --- | ||
|
|
||
| **Is your feature request related to a problem? Please describe.** | ||
| A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] |
There was a problem hiding this comment.
I'm being picky here, sorry, but for consistency: you ended the other sentences with a dot, so maybe worth here also
| A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | |
| A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]. |
|
|
||
| --- | ||
|
|
||
| **Is your feature request related to a problem? Please describe.** |
There was a problem hiding this comment.
I'm being picky here, sorry, but for consistency: you ended the other headline without a dot, so maybe worth here also
| **Is your feature request related to a problem? Please describe.** | |
| **Is your feature request related to a problem? Please describe** |
I went with the form eventually, really liked it. I saw in many projects that feature requests are directed to Discussions instead of Issues which seems legit and helps keeping issue just for bugs, I liked it, would love to hear some thoughts |
This will help us get more useful info when opening an issue or requesting for a feature. It will add button for each when you open a new issue
https://monday.monday.com/boards/3532714909/pulses/5901525815