Skip to content

Commit 0956e02

Browse files
Update issue template (#516)
* Update issue template * Update discussions config * change feature_request
1 parent e9394c7 commit 0956e02

File tree

5 files changed

+95
-47
lines changed

5 files changed

+95
-47
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

-25
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: "🕷️ Bug report"
2+
description: Report errors or unexpected behavior
3+
labels:
4+
- bug
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Self Checks
9+
description: "To make sure we get to you in time, please check the following :)"
10+
options:
11+
- label: This is only for bug report, if you would like to ask a question, please head to [Discussions](https://github.com/fishaudio/fish-speech/discussions).
12+
required: true
13+
- label: I have searched for existing issues [search for existing issues](https://github.com/fishaudio/fish-speech/issues), including closed ones.
14+
required: true
15+
- label: I confirm that I am using English to submit this report (我已阅读并同意 [Language Policy](https://github.com/fishaudio/fish-speech/issues/515)).
16+
required: true
17+
- label: "[FOR CHINESE USERS] 请务必使用英文提交 Issue,否则会被关闭。谢谢!:)"
18+
required: true
19+
- label: "Please do not modify this template :) and fill in all the required fields."
20+
required: true
21+
- type: dropdown
22+
attributes:
23+
label: Cloud or Self Hosted
24+
multiple: true
25+
options:
26+
- Cloud
27+
- Self Hosted (Docker)
28+
- Self Hosted (Source)
29+
validations:
30+
required: true
31+
- type: textarea
32+
attributes:
33+
label: Steps to reproduce
34+
description: We highly suggest including screenshots and a bug report log. Please use the right markdown syntax for code blocks.
35+
placeholder: Having detailed steps helps us reproduce the bug.
36+
validations:
37+
required: true
38+
- type: textarea
39+
attributes:
40+
label: ✔️ Expected Behavior
41+
placeholder: What were you expecting?
42+
validations:
43+
required: false
44+
45+
- type: textarea
46+
attributes:
47+
label: ❌ Actual Behavior
48+
placeholder: What happened instead?
49+
validations:
50+
required: false

.github/ISSUE_TEMPLATE/config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: "\U0001F4E7 Discussions"
4+
url: https://github.com/fishaudio/fish-speech/discussions
5+
about: General discussions and request help from the community

.github/ISSUE_TEMPLATE/feature_request.md

-22
This file was deleted.
+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: "⭐ Feature or enhancement request"
2+
description: Propose something new.
3+
labels:
4+
- enhancement
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Self Checks
9+
description: "To make sure we get to you in time, please check the following :)"
10+
options:
11+
- label: I have searched for existing issues [search for existing issues]([https://github.com/langgenius/dify/issues](https://github.com/fishaudio/fish-speech/issues)), including closed ones.
12+
required: true
13+
- label: I confirm that I am using English to submit this report (我已阅读并同意 [Language Policy](https://github.com/fishaudio/fish-speech/issues/515)).
14+
required: true
15+
- label: "[FOR CHINESE USERS] 请务必使用英文提交 Issue,否则会被关闭。谢谢!:)"
16+
required: true
17+
- label: "Please do not modify this template :) and fill in all the required fields."
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: 1. Is this request related to a challenge you're experiencing? Tell me about your story.
22+
placeholder: Please describe the specific scenario or problem you're facing as clearly as possible. For instance "I was trying to use [feature] for [specific task], and [what happened]... It was frustrating because...."
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: 2. Additional context or comments
28+
placeholder: (Any other information, comments, documentations, links, or screenshots that would provide more clarity. This is the place to add anything else not covered above.)
29+
validations:
30+
required: false
31+
- type: checkboxes
32+
attributes:
33+
label: 3. Can you help us with this feature?
34+
description: Let us know! This is not a commitment, but a starting point for collaboration.
35+
options:
36+
- label: I am interested in contributing to this feature.
37+
required: false
38+
- type: markdown
39+
attributes:
40+
value: Please limit one request per issue.

0 commit comments

Comments
 (0)