mirror of
https://github.com/invoke-ai/InvokeAI
synced 2024-08-30 20:32:17 +00:00
replace old fashined markdown templates with forms
this will help the readability of issues a lot 🤓
This commit is contained in:
parent
22c956c75f
commit
519c661abb
102
.github/ISSUE_TEMPLATE/BUG_REPORT.yml
vendored
Normal file
102
.github/ISSUE_TEMPLATE/BUG_REPORT.yml
vendored
Normal file
@ -0,0 +1,102 @@
|
|||||||
|
name: 🐞 Bug Report
|
||||||
|
|
||||||
|
description: File a bug report
|
||||||
|
|
||||||
|
title: '[bug]: '
|
||||||
|
|
||||||
|
labels: ['bug']
|
||||||
|
|
||||||
|
# assignees:
|
||||||
|
# - moderator_bot
|
||||||
|
# - lstein
|
||||||
|
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for taking the time to fill out this Bug Report!
|
||||||
|
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Is there an existing issue for this?
|
||||||
|
description: |
|
||||||
|
Please use the [search function](https://github.com/invoke-ai/InvokeAI/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
|
||||||
|
irst to see if an issue already exists for the bug you encountered.
|
||||||
|
options:
|
||||||
|
- label: I have searched the existing issues
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: __Describe your environment__
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: os_dropdown
|
||||||
|
attributes:
|
||||||
|
label: OS
|
||||||
|
description: Which operating System did you use when the bug occured
|
||||||
|
multiple: false
|
||||||
|
options:
|
||||||
|
- 'Linux'
|
||||||
|
- 'Windows'
|
||||||
|
- 'macOS'
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: gpu_dropdown
|
||||||
|
attributes:
|
||||||
|
label: GPU
|
||||||
|
description: Which kind of Graphic-Adapter is your System using
|
||||||
|
multiple: false
|
||||||
|
options:
|
||||||
|
- 'cuda'
|
||||||
|
- 'amd'
|
||||||
|
- 'mps'
|
||||||
|
- 'cpu'
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: vram
|
||||||
|
attributes:
|
||||||
|
label: VRAM
|
||||||
|
description: Size of the VRAM if known
|
||||||
|
placeholder: 8GB
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: what-happened
|
||||||
|
attributes:
|
||||||
|
label: What happened?
|
||||||
|
description: |
|
||||||
|
Briefly describe what happened, what you expected to happen and how to reproduce this bug.
|
||||||
|
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:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Additional context
|
||||||
|
description: Add any other context about the problem here
|
||||||
|
placeholder: Only happens when there is full moon and Friday the 13th on Christmas Eve 🎅🏻
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: contact
|
||||||
|
attributes:
|
||||||
|
label: Contact Details
|
||||||
|
description: __OPTIONAL__ How can we get in touch with you if we need more info (besides this issue)?
|
||||||
|
placeholder: ex. email@example.com, discordname, twitter, ...
|
||||||
|
validations:
|
||||||
|
required: false
|
56
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml
vendored
Normal file
56
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml
vendored
Normal file
@ -0,0 +1,56 @@
|
|||||||
|
name: Feature Request
|
||||||
|
description: Commit a idea or Request a new feature
|
||||||
|
title: '[enhancement]: '
|
||||||
|
labels: ['enhancement']
|
||||||
|
# assignees:
|
||||||
|
# - lstein
|
||||||
|
# - tildebyte
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for taking the time to fill out this Feature request!
|
||||||
|
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Is there an existing issue for this?
|
||||||
|
description: |
|
||||||
|
Please make use of the [search function](https://github.com/invoke-ai/InvokeAI/labels/enhancement)
|
||||||
|
to see if a simmilar issue already exists for the feature you want to request
|
||||||
|
options:
|
||||||
|
- label: I have searched the existing issues
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: contact
|
||||||
|
attributes:
|
||||||
|
label: Contact Details
|
||||||
|
description: __OPTIONAL__ How could we get in touch with you if we need more info (besides this issue)?
|
||||||
|
placeholder: ex. email@example.com, discordname, twitter, ...
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: whatisexpected
|
||||||
|
attributes:
|
||||||
|
label: What should this feature add?
|
||||||
|
description: Please try to explain the functionality this feature should add
|
||||||
|
placeholder: |
|
||||||
|
Instead of one huge textfield, it would be nice to have forms for bug-reports, feature-requests, ...
|
||||||
|
Great benefits with automatic labeling, assigning and other functionalitys not available in that form
|
||||||
|
via old-fashioned markdown-templates. I would also love to see the use of a moderator bot 🤖 like
|
||||||
|
https://github.com/marketplace/actions/issue-moderator-with-commands to auto close old issues and other things
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Alternatives
|
||||||
|
description: Describe alternatives you've considered
|
||||||
|
placeholder: A clear and concise description of any alternative solutions or features you've considered.
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Aditional Content
|
||||||
|
description: Add any other context or screenshots about the feature request here.
|
||||||
|
placeholder: This is a Mockup of the design how I imagine it <screenshot>
|
36
.github/ISSUE_TEMPLATE/bug_report.md
vendored
36
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -1,36 +0,0 @@
|
|||||||
---
|
|
||||||
name: Bug report
|
|
||||||
about: Create a report to help us improve
|
|
||||||
title: ''
|
|
||||||
labels: ''
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Describe your environment**
|
|
||||||
- GPU: [cuda/amd/mps/cpu]
|
|
||||||
- VRAM: [if known]
|
|
||||||
- CPU arch: [x86/arm]
|
|
||||||
- OS: [Linux/Windows/macOS]
|
|
||||||
- Python: [Anaconda/miniconda/miniforge/pyenv/other (explain)]
|
|
||||||
- Branch: [if `git status` says anything other than "On branch main" paste it here]
|
|
||||||
- Commit: [run `git show` and paste the line that starts with "Merge" here]
|
|
||||||
|
|
||||||
**Describe the bug**
|
|
||||||
A clear and concise description of what the bug is.
|
|
||||||
|
|
||||||
**To Reproduce**
|
|
||||||
Steps to reproduce the behavior:
|
|
||||||
1. Go to '...'
|
|
||||||
2. Click on '....'
|
|
||||||
3. Scroll down to '....'
|
|
||||||
4. See error
|
|
||||||
|
|
||||||
**Expected behavior**
|
|
||||||
A clear and concise description of what you expected to happen.
|
|
||||||
|
|
||||||
**Screenshots**
|
|
||||||
If applicable, add screenshots to help explain your problem.
|
|
||||||
|
|
||||||
**Additional context**
|
|
||||||
Add any other context about the problem here.
|
|
14
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
14
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: Project-Documentation
|
||||||
|
url: https://invoke-ai.github.io/InvokeAI/
|
||||||
|
about: Should be your first place to go when looking for manuals/FAQs regarding our InvokeAI Toolkit
|
||||||
|
- name: Discord
|
||||||
|
url: https://discord.gg/ZmtBAhwWhy
|
||||||
|
about: Our Discord Community could maybe help you out via live-chat
|
||||||
|
- name: GitHub Community Support
|
||||||
|
url: https://github.com/orgs/community/discussions
|
||||||
|
about: Please ask and answer questions regarding the GitHub Platform here.
|
||||||
|
- name: GitHub Security Bug Bounty
|
||||||
|
url: https://bounty.github.com/
|
||||||
|
about: Please report security vulnerabilities of the GitHub Platform here.
|
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@ -1,20 +0,0 @@
|
|||||||
---
|
|
||||||
name: Feature request
|
|
||||||
about: Suggest an idea for this project
|
|
||||||
title: ''
|
|
||||||
labels: ''
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**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 [...]
|
|
||||||
|
|
||||||
**Describe the solution you'd like**
|
|
||||||
A clear and concise description of what you want to happen.
|
|
||||||
|
|
||||||
**Describe alternatives you've considered**
|
|
||||||
A clear and concise description of any alternative solutions or features you've considered.
|
|
||||||
|
|
||||||
**Additional context**
|
|
||||||
Add any other context or screenshots about the feature request here.
|
|
Loading…
Reference in New Issue
Block a user