chore: add bug issue template #150
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds a bug report template to GitHub's issue templates to help users report bugs more effectively.
- Introduces a structured Markdown bug report template with sections such as Description, Affected Apps, Affected Models, and Additional Context.
- Sets default labels and metadata for new bug reports.
| - label: Windsurf | ||
| - label: VSCode | ||
| - label: VSCode Insiders | ||
| - label: Claude Desktop |
There was a problem hiding this comment.
Should we have Other here?
| - label: "Claude 3.5 Sonnet" | ||
| - label: "Claude 3.7 Sonnet" | ||
| - label: "GPT-4a" | ||
| - label: "o4-mini" |
There was a problem hiding this comment.
Similarly, perhaps add "Other" or just leave it as an input so that we don't have to constantly update the list.
| label: "Screenshots" | ||
| description: "If applicable, add links to screenshots to help explain your problem." | ||
| placeholder: "e.g., Screenshot URLs or descriptions." | ||
| - type: textarea |
There was a problem hiding this comment.
We probably don't need this since most of it will already have been included in the description.
| label: "Expected Behavior" | ||
| description: "Describe what you expected to happen." | ||
| placeholder: "e.g., The app should not crash and should display the dashboard." | ||
| - type: textarea |
There was a problem hiding this comment.
Probably don't need this either - I expect people will add all the context they can think of in the description already.
| - type: textarea | ||
| id: screenshots | ||
| attributes: | ||
| label: "Screenshots" |
There was a problem hiding this comment.
I feel screenshots might not be relevant here as we're building a text interface, so I hope people will copy-paste issues they encounter rather than sending us a screenshot of a conversation with a chatbot. Additionally, pasting links to screenshots is a bit annoying and a potential malware vector (I am always extremely cautious when clicking any user-supplied links). Instead, we could add a readonly (i.e. markdown) section, instructing users that if they need to provide additional context or screenshots, they can add them as a comment after filing the issue (since adding a comment allows you to directly upload the image).
Co-authored-by: Nikola Irinchev <[email protected]>
Co-authored-by: Nikola Irinchev <[email protected]>
Co-authored-by: Nikola Irinchev <[email protected]>
No description provided.