Skip to content

Commit 0b474fb

Browse files
upload some issue templates
1 parent ac70196 commit 0b474fb

13 files changed

Lines changed: 543 additions & 0 deletions
Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
name: "🐛 Bug report"
2+
description: "Report a reproducible bug."
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug.
10+
Please fill in the information below so we can reproduce and fix it faster.
11+
12+
- type: dropdown
13+
id: severity
14+
attributes:
15+
label: Severity
16+
options:
17+
- "S1 - Critical (crash/data loss/security)"
18+
- "S2 - High (major feature broken)"
19+
- "S3 - Medium (workaround exists)"
20+
- "S4 - Low (minor / cosmetic)"
21+
validations:
22+
required: true
23+
24+
- type: input
25+
id: version
26+
attributes:
27+
label: Version / Commit
28+
description: "Which version are you using? (e.g., v1.2.3, commit SHA)"
29+
placeholder: "v1.2.3 / 1a2b3c4"
30+
validations:
31+
required: false
32+
33+
- type: textarea
34+
id: what_happened
35+
attributes:
36+
label: What happened?
37+
description: "Describe the bug clearly."
38+
placeholder: "A clear and concise description..."
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: expected
44+
attributes:
45+
label: What did you expect?
46+
placeholder: "Expected behavior..."
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: steps
52+
attributes:
53+
label: Steps to reproduce
54+
description: "Provide minimal steps to reproduce."
55+
placeholder: |
56+
1. Go to ...
57+
2. Run ...
58+
3. See error ...
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
id: logs
64+
attributes:
65+
label: Logs / Screenshots
66+
description: "Paste logs or attach screenshots if applicable."
67+
render: shell
68+
validations:
69+
required: false
70+
71+
- type: textarea
72+
id: env
73+
attributes:
74+
label: Environment
75+
description: "OS / runtime / dependencies"
76+
placeholder: |
77+
- OS: Windows 11 / Ubuntu 22.04 / macOS 14
78+
- Runtime: Python 3.11 / Node 20
79+
- Package manager: pip/conda/npm
80+
validations:
81+
required: false
82+
83+
- type: checkboxes
84+
id: checklist
85+
attributes:
86+
label: Checklist
87+
options:
88+
- label: "I searched existing issues and did not find a duplicate."
89+
required: true
90+
- label: "I can reproduce this consistently."
91+
required: false
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
name: "🐛 缺陷反馈"
2+
description: "报告一个可复现的 Bug。"
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
感谢反馈!请尽量补全信息,便于我们快速复现与修复。
10+
11+
- type: dropdown
12+
id: severity
13+
attributes:
14+
label: 严重程度
15+
options:
16+
- "S1 - 致命 (崩溃/数据丢失/安全)"
17+
- "S2 - 高 (核心功能不可用)"
18+
- "S3 - 中 (有替代方案)"
19+
- "S4 - 低 (小问题/界面问题)"
20+
validations:
21+
required: true
22+
23+
- type: input
24+
id: version
25+
attributes:
26+
label: 版本 / 提交号
27+
description: "你使用的版本 (例如 v1.2.3 或 commit SHA)"
28+
placeholder: "v1.2.3 / 1a2b3c4"
29+
validations:
30+
required: false
31+
32+
- type: textarea
33+
id: what_happened
34+
attributes:
35+
label: 实际发生了什么?
36+
description: "清晰描述 Bug 现象。"
37+
placeholder: "现象描述..."
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: expected
43+
attributes:
44+
label: 期望结果是什么?
45+
placeholder: "期望行为..."
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
id: steps
51+
attributes:
52+
label: 复现步骤
53+
description: "给出最小可复现步骤。"
54+
placeholder: |
55+
1. 打开 ...
56+
2. 执行 ...
57+
3. 出现 ...
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
id: logs
63+
attributes:
64+
label: 日志 / 截图
65+
description: "粘贴日志或附上截图 (如适用)。"
66+
render: shell
67+
validations:
68+
required: false
69+
70+
- type: textarea
71+
id: env
72+
attributes:
73+
label: 环境信息
74+
description: "OS / 运行时 / 依赖版本等"
75+
placeholder: |
76+
- OS: Windows 11 / Ubuntu 22.04 / macOS 14
77+
- Runtime: Python 3.11 / Node 20
78+
- 包管理: pip/conda/npm
79+
validations:
80+
required: false
81+
82+
- type: checkboxes
83+
id: checklist
84+
attributes:
85+
label: 检查项
86+
options:
87+
- label: "我已搜索现有 issues, 未发现重复。"
88+
required: true
89+
- label: "我可以稳定复现该问题。"
90+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 Discussions / 讨论区
4+
url: https://github.com/CharlesPikachu/musicsquare/discussions
5+
about: Please ask and answer questions here. / 建议在讨论区提问与交流。
6+
- name: 🔒 Security / 安全问题
7+
url: https://github.com/CharlesPikachu/musicsquare/security/policy
8+
about: Please report security vulnerabilities privately. / 安全漏洞请私下提交。
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: "📚 Documentation"
2+
description: "Report missing/incorrect docs or propose improvements."
3+
title: "[Docs]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: textarea
7+
id: issue
8+
attributes:
9+
label: What's wrong / missing?
10+
placeholder: "The docs are unclear about..."
11+
validations:
12+
required: true
13+
14+
- type: input
15+
id: page
16+
attributes:
17+
label: Related page / section
18+
placeholder: "Link or path to the docs page"
19+
validations:
20+
required: false
21+
22+
- type: textarea
23+
id: suggestion
24+
attributes:
25+
label: Suggested change
26+
placeholder: "Proposed wording / examples..."
27+
validations:
28+
required: false
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: "📚 文档问题"
2+
description: "反馈文档缺失/错误或提出改进建议。"
3+
title: "[Docs]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: textarea
7+
id: issue
8+
attributes:
9+
label: 哪里不对 / 缺什么?
10+
placeholder: "文档在...部分不清晰/错误..."
11+
validations:
12+
required: true
13+
14+
- type: input
15+
id: page
16+
attributes:
17+
label: 相关页面 / 章节
18+
placeholder: "文档链接或路径"
19+
validations:
20+
required: false
21+
22+
- type: textarea
23+
id: suggestion
24+
attributes:
25+
label: 建议修改
26+
placeholder: "建议的表述 / 示例..."
27+
validations:
28+
required: false
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: "✨ Feature request"
2+
description: "Suggest an idea or improvement."
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: textarea
7+
id: problem
8+
attributes:
9+
label: Problem statement
10+
description: "What problem are you trying to solve?"
11+
placeholder: "I'm frustrated when..."
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: proposal
17+
attributes:
18+
label: Proposed solution
19+
description: "What would you like to happen?"
20+
placeholder: "It would be great if..."
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: alternatives
26+
attributes:
27+
label: Alternatives considered
28+
placeholder: "Other approaches..."
29+
validations:
30+
required: false
31+
32+
- type: dropdown
33+
id: priority
34+
attributes:
35+
label: Priority
36+
options:
37+
- "P0 - Must have"
38+
- "P1 - Should have"
39+
- "P2 - Nice to have"
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: context
45+
attributes:
46+
label: Additional context
47+
description: "Mockups, references, related issues/PRs."
48+
validations:
49+
required: false
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: "✨ 功能需求"
2+
description: "提出新功能或改进建议。"
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: textarea
7+
id: problem
8+
attributes:
9+
label: 需求背景 / 痛点
10+
description: "你想解决什么问题?"
11+
placeholder: "目前困扰是..."
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: proposal
17+
attributes:
18+
label: 期望方案
19+
description: "你希望系统如何改进?"
20+
placeholder: "希望可以..."
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: alternatives
26+
attributes:
27+
label: 备选方案
28+
placeholder: "其他可能的实现方式..."
29+
validations:
30+
required: false
31+
32+
- type: dropdown
33+
id: priority
34+
attributes:
35+
label: 优先级
36+
options:
37+
- "P0 - 必须"
38+
- "P1 - 应该"
39+
- "P2 - 可选"
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: context
45+
attributes:
46+
label: 补充信息
47+
description: "原型图、参考链接、相关 issue/PR 等。"
48+
validations:
49+
required: false
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: "🚀 Performance"
2+
description: "Report a performance issue or regression."
3+
title: "[Perf]: "
4+
labels: ["performance"]
5+
body:
6+
- type: textarea
7+
id: summary
8+
attributes:
9+
label: Summary
10+
placeholder: "What is slow and where?"
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: baseline
16+
attributes:
17+
label: Baseline vs Current
18+
placeholder: |
19+
Baseline: 120ms
20+
Current: 600ms
21+
Regression since: v1.2.0
22+
validations:
23+
required: false
24+
25+
- type: textarea
26+
id: steps
27+
attributes:
28+
label: Steps to reproduce / benchmark
29+
placeholder: "Command / script / dataset / input size..."
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: profiling
35+
attributes:
36+
label: Profiling info
37+
placeholder: "Profiler output, flamegraph, timing breakdown..."
38+
validations:
39+
required: false

0 commit comments

Comments
 (0)