chore: add bug issue template #150
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| --- | ||
| name: "Bug Report" | ||
| description: "Report a bug to help us improve." | ||
| title: "[Bug]: <title>" | ||
| type: "Bug" | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: "Please fill out the following details to help us address the issue." | ||
| - type: input | ||
| id: title | ||
| attributes: | ||
| label: "Bug Title" | ||
| description: "Provide a short and descriptive title for the bug." | ||
| placeholder: "e.g., App crashes on startup" | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: "Bug Description" | ||
| description: "Describe the bug in detail. Include steps to reproduce, expected behavior, and actual behavior." | ||
fmenezes marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| placeholder: "e.g., When I open the app, it crashes with error XYZ." | ||
fmenezes marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: app | ||
| attributes: | ||
| label: "App" | ||
| description: "Select the app where the bug occurred." | ||
| options: | ||
| - label: Cursor | ||
| - label: Windsurf | ||
| - label: VSCode | ||
| - label: VSCode Insiders | ||
| - label: Claude Desktop | ||
|
There was a problem hiding this comment. Should we have |
||
| - type: checkboxes | ||
| id: affected_models | ||
| attributes: | ||
| label: "Affected Models (if applicable)" | ||
| description: "Select the models affected by the bug." | ||
| options: | ||
| - 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. |
||
| - type: textarea | ||
| id: steps_to_reproduce | ||
| attributes: | ||
| label: "Steps to Reproduce" | ||
| description: "Provide the steps to reproduce the bug." | ||
| placeholder: "e.g., 1. Go to '...'; 2. Click on '...'; 3. See error." | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: prompts | ||
| attributes: | ||
| label: "Prompts" | ||
| description: "Report on which prompts were used." | ||
| placeholder: "e.g., Prompt details or examples." | ||
| - 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). |
||
| 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. |
||
| id: expected_behavior | ||
| attributes: | ||
| 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. |
||
| id: additional_context | ||
| attributes: | ||
| label: "Additional Context" | ||
| description: "Add any other context or screenshots that might help us understand the issue." | ||
| placeholder: "e.g., Logs, screenshots, or related issues." | ||
Uh oh!
There was an error while loading. Please reload this page.