chore: update issue template

- Improve spelling and grammar
- Add browser, GPU model, python deps fields
- Revise other fields
This commit is contained in:
psychedelicious 2024-01-29 13:47:09 +11:00
parent 3f5370b284
commit 13575642d8

View File

@ -6,10 +6,6 @@ title: '[bug]: '
labels: ['bug'] labels: ['bug']
# assignees:
# - moderator_bot
# - lstein
body: body:
- type: markdown - type: markdown
attributes: attributes:
@ -18,10 +14,9 @@ body:
- type: checkboxes - type: checkboxes
attributes: attributes:
label: Is there an existing issue for this? label: Is there an existing issue for this problem?
description: | description: |
Please use the [search function](https://github.com/invoke-ai/InvokeAI/issues?q=is%3Aissue+is%3Aopen+label%3Abug) Please [search](https://github.com/invoke-ai/InvokeAI/issues) first to see if an issue already exists for the problem.
irst to see if an issue already exists for the bug you encountered.
options: options:
- label: I have searched the existing issues - label: I have searched the existing issues
required: true required: true
@ -33,35 +28,45 @@ body:
- type: dropdown - type: dropdown
id: os_dropdown id: os_dropdown
attributes: attributes:
label: OS label: Operating system
description: Which operating System did you use when the bug occured description: Your computer's operating system.
multiple: false multiple: false
options: options:
- 'Linux' - 'Linux'
- 'Windows' - 'Windows'
- 'macOS' - 'macOS'
- 'other'
validations: validations:
required: true required: true
- type: dropdown - type: dropdown
id: gpu_dropdown id: gpu_dropdown
attributes: attributes:
label: GPU label: GPU vendor
description: Which kind of Graphic-Adapter is your System using description: Your GPU's vendor.
multiple: false multiple: false
options: options:
- 'cuda' - 'Nvidia (CUDA)'
- 'amd' - 'AMD (ROCm)'
- 'mps' - 'Apple Silicon (MPS)'
- 'cpu' - 'None (CPU)'
validations: validations:
required: true required: true
- type: input
id: gpu_model
attributes:
label: GPU model
description: Your GPU's model. If on Apple Silicon, this is your Mac's chip. Leave blank if on CPU.
placeholder: ex. RTX 2080 Ti, Mac M1 Pro
validations:
required: false
- type: input - type: input
id: vram id: vram
attributes: attributes:
label: VRAM label: GPU VRAM
description: Size of the VRAM if known description: Your GPU's VRAM. If on Apple Silicon, this is your Mac's unified memory. Leave blank if on CPU.
placeholder: 8GB placeholder: 8GB
validations: validations:
required: false required: false
@ -69,44 +74,73 @@ body:
- type: input - type: input
id: version-number id: version-number
attributes: attributes:
label: What version did you experience this issue on? label: Version number
description: | description: |
Please share the version of Invoke AI that you experienced the issue on. If this is not the latest version, please update first to confirm the issue still exists. If you are testing main, please include the commit hash instead. The version of Invoke you have installed. If it is not the latest version, please update and try again to confirm the issue still exists. If you are testing main, please include the commit hash instead.
placeholder: X.X.X placeholder: ex. 3.6.1
validations:
required: true
- type: input
id: browser-version
attributes:
label: Browser
description: Your web browser and version.
placeholder: ex. Firefox 123.0b3
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: what-happened id: python-deps
attributes: attributes:
label: What happened? label: Python dependencies
description: | description: |
Briefly describe what happened, what you expected to happen and how to reproduce this bug. If the problem occurred during image generation, click the gear icon at the bottom left corner, click "About", click the copy button and then paste here.
placeholder: When using the webinterface and right-clicking on button X instead of the popup-menu there error Y appears
validations:
required: true
- type: textarea
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain your problem
placeholder: this is what the result looked like <screenshot>
validations: validations:
required: false required: false
- type: textarea - type: textarea
id: what-happened
attributes:
label: What happened
description: |
Describe what happened. Include any relevant error messages, stack traces and screenshots here.
placeholder: I clicked button X and then Y happened.
validations:
required: true
- type: textarea
id: what-you-expected
attributes:
label: What you expected to happen
description: Describe what you expected to happen.
placeholder: I expected Z to happen.
validations:
required: true
- type: textarea
id: how-to-repro
attributes:
label: How to reproduce the problem
description: List steps to reproduce the problem.
placeholder: Start the app, generate an image with these settings, then click button X.
validations:
required: false
- type: textarea
id: additional-context
attributes: attributes:
label: Additional context label: Additional context
description: Add any other context about the problem here description: Any other context that might help us to understand the problem.
placeholder: Only happens when there is full moon and Friday the 13th on Christmas Eve 🎅🏻 placeholder: Only happens when there is full moon and Friday the 13th on Christmas Eve 🎅🏻
validations: validations:
required: false required: false
- type: input - type: input
id: contact id: discord-username
attributes: attributes:
label: Contact Details label: Discord username
description: __OPTIONAL__ How can we get in touch with you if we need more info (besides this issue)? description: If you are on the Invoke discord and would prefer to be contacted there, please provide your username.
placeholder: ex. email@example.com, discordname, twitter, ... placeholder: supercoolusername123
validations: validations:
required: false required: false