Skip to content

Commit 82ce538

Browse files
lanyeeeelanyeeee
committed
feat: add issue templates
1 parent 862a371 commit 82ce538

File tree

5 files changed

+240
-0
lines changed

5 files changed

+240
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: Bug Report
2+
description: Report issues you encountered
3+
labels: [bug]
4+
title: "[Bug] Edit Me! Issues with unmodified title will be automatically closed"
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Prerequisites
9+
options:
10+
- label: I have tried the latest version and I can confirm that this issue still exists.
11+
required: true
12+
- label: I will write this issue with a collaborative spirit, providing as much detail as possible, not just an error message or a screenshot.
13+
required: true
14+
- type: textarea
15+
id: desc
16+
attributes:
17+
label: Bug Description
18+
description: What happened? What's the current situation? Which Comic? Can the issue be consistently reproduced?
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: reproduction
23+
attributes:
24+
label: Steps to Reproduce
25+
description: This is the **most important** part of the entire issue. Please refer to [this issue](https://github.com/lanyeeee/hitomi-downloader/issues/4) for an example of how to write detailed reproduction steps.
26+
placeholder: Reproduction Steps are the biggest factor affecting issue processing efficiency. Without detailed reproduction steps, the issue will be difficult to locate, and developers will need to spend a lot of time communicating back and forth to pinpoint the issue
27+
validations:
28+
required: true
29+
- type: checkboxes
30+
attributes:
31+
label: Reproduction Steps are Crucial
32+
description: Providing only an error message or a screenshot without reproduction steps makes the issue difficult to locate and, therefore, difficult to solve. Detailed reproduction steps also show respect for the maintainers' work.
33+
options:
34+
- label: I have referred to [this issue](https://github.com/lanyeeee/hitomi-downloader/issues/4) and have written detailed steps in the **Steps to Reproduce** section.
35+
required: true
36+
- type: textarea
37+
id: expected
38+
attributes:
39+
label: Expected Behavior
40+
description: What did you expect to happen?
41+
validations:
42+
required: true
43+
- type: textarea
44+
id: actual
45+
attributes:
46+
label: Actual Behavior
47+
description: What actually happened?
48+
validations:
49+
required: true
50+
- type: textarea
51+
id: logs
52+
attributes:
53+
label: Logs
54+
description: Please provide any relevant logs.
55+
placeholder: |
56+
If the logs are short, you can paste them here directly.
57+
58+
If the logs are very long, please save them to a .txt file and upload it by dragging it into the text box or clicking the add files button below.
59+
validations:
60+
required: false
61+
- type: textarea
62+
id: media
63+
attributes:
64+
label: Screenshots or Screen Recordings
65+
description: Screenshots or screen recordings that demonstrate the issue.
66+
placeholder: You can drag and drop files here or click the add files button below.
67+
- type: input
68+
id: version
69+
attributes:
70+
label: Version(Check by clicking the "About" button)
71+
placeholder: v0.1.0
72+
validations:
73+
required: true
74+
- type: textarea
75+
id: other
76+
attributes:
77+
label: Additional Context
78+
description: Add any other context about the problem here.
79+
placeholder: Any other supplementary information.
80+
validations:
81+
required: false

‎.github/ISSUE_TEMPLATE/bug_report.zh-CN.yml‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: 反馈 Bug
2+
description: 反馈遇到的问题
3+
labels: [bug]
4+
title: "[Bug] 修改我！未修改标题的issue将被自动关闭"
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: 在提交BUG之前
9+
options:
10+
- label: 我尝试使用了最新版，我确定这个问题在最新版中依然存在
11+
required: true
12+
- label: 我会以「一起合作来解决问题」的态度编写issue，尽力提供详细信息，而不是仅提供报错信息或截图
13+
required: true
14+
- type: textarea
15+
id: desc
16+
attributes:
17+
label: 问题描述
18+
description: 发生了什么情况？有什么现状？哪部漫画？哪个章节？问题能稳定触发吗？
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: reproduction
23+
attributes:
24+
label: 复现步骤
25+
description: 这是整个issue中**最重要**的部分。请参考[这个issue](https://github.com/lanyeeee/hitomi-downloader/issues/3)编写详细的复现步骤
26+
placeholder: 复现步骤是影响issue处理效率的最大因素，没有详细的复现步骤将导致问题难以被定位，开发者需要花费大量时间来回沟通以定位问题
27+
validations:
28+
required: true
29+
- type: checkboxes
30+
attributes:
31+
label: 复现步骤非常重要
32+
description: 仅提供报错信息或截图而没有复现步骤，问题难以被定位，也就难以被解决。详细的复现步骤也是对项目维护工作的尊重
33+
options:
34+
- label: 我已经参考[这个issue](https://github.com/lanyeeee/hitomi-downloader/issues/3)在**复现步骤**中编写了详细的复现步骤
35+
required: true
36+
- type: textarea
37+
id: expected
38+
attributes:
39+
label: 预期行为
40+
description: 正常情况下应该发生什么
41+
validations:
42+
required: true
43+
- type: textarea
44+
id: actual
45+
attributes:
46+
label: 实际行为
47+
description: 实际上发生了什么
48+
validations:
49+
required: true
50+
- type: textarea
51+
id: logs
52+
attributes:
53+
label: 日志
54+
description: 请提供相关的日志信息
55+
placeholder: |
56+
如果相关日志比较短可以直接粘贴
57+
58+
如果相关日志很长，建议将相关日志保存为txt，然后点击文本框下面小长条上传文件
59+
validations:
60+
required: false
61+
- type: textarea
62+
id: media
63+
attributes:
64+
label: 截图或录屏
65+
description: 问题复现时候的截图或录屏
66+
placeholder: 点击文本框下面小长条可以上传文件
67+
- type: input
68+
id: version
69+
attributes:
70+
label: 工具版本号(点击`关于`按钮查看)
71+
placeholder: v0.1.0
72+
validations:
73+
required: true
74+
- type: textarea
75+
id: other
76+
attributes:
77+
label: 其他
78+
description: 其他要补充的内容
79+
placeholder: 其他要补充的内容
80+
validations:
81+
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: ❓ Questions & Discussions
4+
url: https://github.com/lanyeeee/hitomi-downloader/discussions
5+
about: Use GitHub discussions for message-board style questions and discussions.
6+
- name: ❓ 提问与讨论
7+
url: https://github.com/lanyeeee/hitomi-downloader/discussions
8+
about: 如果有一般性问题或想发起讨论，请使用 GitHub Discussions

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Feature Request
2+
description: Request to add a specific feature
3+
labels: [enhancement]
4+
title: "[Feature Request] Edit Me! Issues with unmodified title will be automatically closed"
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
To help me understand your idea, please provide the following information and edit the title above.
10+
- type: textarea
11+
id: reason
12+
attributes:
13+
label: Reason
14+
description: Why is this feature needed? What problem does it solve?
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: desc
19+
attributes:
20+
label: Feature Description
21+
description: A clear and concise description of the feature you're proposing
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: logic
26+
attributes:
27+
label: Feature Logic
28+
description: How to interact, how to use, etc.
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: ref
33+
attributes:
34+
label: Implementation Reference
35+
description: Possible ways to implement this feature, or other applications that have already implemented this feature, etc.

‎.github/ISSUE_TEMPLATE/feature_request.zh-CN.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: 功能请求
2+
description: 想要请求添加某个功能
3+
labels: [enhancement]
4+
title: "[功能请求] 修改我！未修改标题的issue将被自动关闭"
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
为了使我更好地帮助你，请提供以下信息。以及上方的标题
10+
- type: textarea
11+
id: reason
12+
attributes:
13+
label: 原因
14+
description: 为什么想要这个功能
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: desc
19+
attributes:
20+
label: 功能简述
21+
description: 想要个怎样的功能
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: logic
26+
attributes:
27+
label: 功能逻辑
28+
description: 如何互交、如何使用等
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: ref
33+
attributes:
34+
label: 实现参考
35+
description: 该功能可能的实现方式，或者其他已经实现该功能的应用等

0 commit comments

Comments
 (0)