Skip to content

Commit 8aa4a25

Browse files
mauwiilstein
authored andcommitted
replace old fashined markdown templates with forms
this will help the readability of issues a lot 🤓
1 parent 174a9b7 commit 8aa4a25

File tree

5 files changed

+172
-56
lines changed

5 files changed

+172
-56
lines changed
Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
name: 🐞 Bug Report
2+
3+
description: File a bug report
4+
5+
title: '[bug]: '
6+
7+
labels: ['bug']
8+
9+
# assignees:
10+
# - moderator_bot
11+
# - lstein
12+
13+
body:
14+
- type: markdown
15+
attributes:
16+
value: |
17+
Thanks for taking the time to fill out this Bug Report!
18+
19+
- type: checkboxes
20+
attributes:
21+
label: Is there an existing issue for this?
22+
description: |
23+
Please use the [search function](https://github.com/invoke-ai/InvokeAI/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
24+
irst to see if an issue already exists for the bug you encountered.
25+
options:
26+
- label: I have searched the existing issues
27+
required: true
28+
29+
- type: markdown
30+
attributes:
31+
value: __Describe your environment__
32+
33+
- type: dropdown
34+
id: os_dropdown
35+
attributes:
36+
label: OS
37+
description: Which operating System did you use when the bug occured
38+
multiple: false
39+
options:
40+
- 'Linux'
41+
- 'Windows'
42+
- 'macOS'
43+
validations:
44+
required: true
45+
46+
- type: dropdown
47+
id: gpu_dropdown
48+
attributes:
49+
label: GPU
50+
description: Which kind of Graphic-Adapter is your System using
51+
multiple: false
52+
options:
53+
- 'cuda'
54+
- 'amd'
55+
- 'mps'
56+
- 'cpu'
57+
validations:
58+
required: true
59+
60+
- type: input
61+
id: vram
62+
attributes:
63+
label: VRAM
64+
description: Size of the VRAM if known
65+
placeholder: 8GB
66+
validations:
67+
required: false
68+
69+
- type: textarea
70+
id: what-happened
71+
attributes:
72+
label: What happened?
73+
description: |
74+
Briefly describe what happened, what you expected to happen and how to reproduce this bug.
75+
placeholder: When using the webinterface and right-clicking on button X instead of the popup-menu there error Y appears
76+
validations:
77+
required: true
78+
79+
- type: textarea
80+
attributes:
81+
label: Screenshots
82+
description: If applicable, add screenshots to help explain your problem
83+
placeholder: this is what the result looked like <screenshot>
84+
validations:
85+
required: false
86+
87+
- type: textarea
88+
attributes:
89+
label: Additional context
90+
description: Add any other context about the problem here
91+
placeholder: Only happens when there is full moon and Friday the 13th on Christmas Eve 🎅🏻
92+
validations:
93+
required: false
94+
95+
- type: input
96+
id: contact
97+
attributes:
98+
label: Contact Details
99+
description: __OPTIONAL__ How can we get in touch with you if we need more info (besides this issue)?
100+
placeholder: ex. [email protected], discordname, twitter, ...
101+
validations:
102+
required: false
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Feature Request
2+
description: Commit a idea or Request a new feature
3+
title: '[enhancement]: '
4+
labels: ['enhancement']
5+
# assignees:
6+
# - lstein
7+
# - tildebyte
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thanks for taking the time to fill out this Feature request!
13+
14+
- type: checkboxes
15+
attributes:
16+
label: Is there an existing issue for this?
17+
description: |
18+
Please make use of the [search function](https://github.com/invoke-ai/InvokeAI/labels/enhancement)
19+
to see if a simmilar issue already exists for the feature you want to request
20+
options:
21+
- label: I have searched the existing issues
22+
required: true
23+
24+
- type: input
25+
id: contact
26+
attributes:
27+
label: Contact Details
28+
description: __OPTIONAL__ How could we get in touch with you if we need more info (besides this issue)?
29+
placeholder: ex. [email protected], discordname, twitter, ...
30+
validations:
31+
required: false
32+
33+
- type: textarea
34+
id: whatisexpected
35+
attributes:
36+
label: What should this feature add?
37+
description: Please try to explain the functionality this feature should add
38+
placeholder: |
39+
Instead of one huge textfield, it would be nice to have forms for bug-reports, feature-requests, ...
40+
Great benefits with automatic labeling, assigning and other functionalitys not available in that form
41+
via old-fashioned markdown-templates. I would also love to see the use of a moderator bot 🤖 like
42+
https://github.com/marketplace/actions/issue-moderator-with-commands to auto close old issues and other things
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
attributes:
48+
label: Alternatives
49+
description: Describe alternatives you've considered
50+
placeholder: A clear and concise description of any alternative solutions or features you've considered.
51+
52+
- type: textarea
53+
attributes:
54+
label: Aditional Content
55+
description: Add any other context or screenshots about the feature request here.
56+
placeholder: This is a Mockup of the design how I imagine it <screenshot>

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Project-Documentation
4+
url: https://invoke-ai.github.io/InvokeAI/
5+
about: Should be your first place to go when looking for manuals/FAQs regarding our InvokeAI Toolkit
6+
- name: Discord
7+
url: https://discord.gg/ZmtBAhwWhy
8+
about: Our Discord Community could maybe help you out via live-chat
9+
- name: GitHub Community Support
10+
url: https://github.com/orgs/community/discussions
11+
about: Please ask and answer questions regarding the GitHub Platform here.
12+
- name: GitHub Security Bug Bounty
13+
url: https://bounty.github.com/
14+
about: Please report security vulnerabilities of the GitHub Platform here.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)