ci: add some issues template

This commit is contained in:
ihmily 2024-10-25 18:16:03 +08:00
parent 0b7d2508ba
commit da09583de8
6 changed files with 282 additions and 16 deletions

View File

@ -1,12 +1,13 @@
name: 🐛 Bug report
description: 项目运行中遇到的Bug或问题。
labels: ["status: issue-bug"]
description: 创建Bug报告以帮助项目改进。
title: 🐛[BUG] 请输入标题
labels: bug
body:
- type: markdown
attributes:
value: |
📝 **请在上方的`title`中填写一个简洁明了的标题**,格式建议为:[Bug] 简短描述。
例如:[Bug] B站某些直播间无法录制。
📝 **请在上方的`title`中填写一个简洁明了的标题**,格式建议为:🐛[Bug] 简短描述。
例如:🐛[Bug] B站某些直播间无法录制。
- type: checkboxes
attributes:
label: ⚠️ 确认是否已存在类似问题
@ -23,6 +24,7 @@ body:
options:
- 直接运行的exe文件
- 使用源代码运行
- 使用docker运行
validations:
required: true
- type: dropdown
@ -30,14 +32,28 @@ body:
label: 🐍 如果是使用源代码运行请选择你的Python环境版本
description: 请选择你运行程序的Python版本。
options:
- Python 3.8
- Python 3.9
- Python 3.10
- Python 3.11
- Python 3.12
- Python 3.13
- Other (请在问题中说明)
validations:
required: false
- type: dropdown
attributes:
label: 💻 请选择你的系统环境
description: 请选择你运行程序的具体系统版本。
options:
- Windows 10
- Windows 11
- macOS
- Ubuntu
- CentOS
- Fedora
- Debian
- Other (请在问题中说明)
validations:
required: true
- type: checkboxes
attributes:
label: ⚠️ 确认是否已经重试多次

91
.github/ISSUE_TEMPLATE/bug_en.yml vendored Normal file
View File

@ -0,0 +1,91 @@
name: 🐛 (English)Bug report
description: Create a bug report to help improve the project.
title: 🐛[BUG] Please enter a title
labels: bug
body:
- type: markdown
attributes:
value: |
📝 **Please fill in a concise and clear title in the `title` above**, the format is suggested as: 🐛[Bug] Short description.
For example: 🐛[Bug] Unable to record certain TikTok live rooms.
- type: checkboxes
attributes:
label: ⚠️ Confirm if similar issues exist
description: >
🔍 [Click here to search historical issues](https://github.com/ihmily/DouyinLiveRecorder/issues?q=is%3Aissue)
Please make sure your issue hasn't been reported before.
options:
- label: I have searched the issues and found no similar problems
required: true
- type: dropdown
attributes:
label: 🔧 How did you run the program?
description: Please select how you ran the program.
options:
- Directly running the exe file
- Running with source code
- Running with docker
validations:
required: true
- type: dropdown
attributes:
label: 🐍 If running with source code, please select your Python environment version
description: Please select the Python version you used to run the program.
options:
- Python 3.10
- Python 3.11
- Python 3.12
- Python 3.13
- Other (please specify in the issue)
validations:
required: false
- type: dropdown
attributes:
label: 💻 Please select your system environment
description: Please select the specific system version you are running the program on.
options:
- Windows 10
- Windows 11
- macOS
- Ubuntu
- CentOS
- Fedora
- Debian
- Other (please specify in the issue)
validations:
required: true
- type: checkboxes
attributes:
label: ⚠️ Confirm if you have retried multiple times
description: >
Sometimes it might be due to your device or network issues.
options:
- label: I have tried multiple times and still encounter the problem
required: true
- type: textarea
attributes:
label: 🕹 Reproduction steps
description: |
**⚠️ Issues that cannot be reproduced will be closed.**
Please fill in according to the following format:
1. The live room address I tried to record is...
2. The recording format I used is...
3. ...
placeholder: |
1. ...
2. ...
3. ...
validations:
required: true
- type: textarea
attributes:
label: 😯 Problem description
description: Describe the problem in detail or provide relevant screenshots.
validations:
required: true
- type: textarea
attributes:
label: 📜 Error information
description: If available, please paste the relevant log error information or screenshots.
validations:
required: false

View File

@ -1,17 +1,18 @@
name: 🚀 Feature request
description: 提出你对项目的新想法或建议。
labels: ["status: issue-feature"]
title: 🚀[Feature] 请输入标题
labels: enhancement
body:
- type: markdown
attributes:
value: |
📝 **请在上方的`title`中填写一个简洁明了的标题**,格式建议为:[Feature] 简短描述。
例如:[Feature] 添加xx直播录制。
📝 **请在上方的`title`中填写一个简洁明了的标题**,格式建议为:🚀[Feature] 简短描述。
例如:🚀[Feature] 添加xx直播录制。
- type: checkboxes
attributes:
label: ⚠️ 搜索是否存在类似issue
description: >
🔍 请在 [历史issue](https://github.com/ihmily/DouyinLiveRecorder/issues) 中清空输入框,使用关键词搜索确保没有重复的issue。
🔍 [点击这里搜索历史issue](https://github.com/ihmily/DouyinLiveRecorder/issues?q=is%3Aissue) 使用关键词搜索确保没有重复的issue。
options:
- label: 我已经搜索过issues没有发现相似issue
required: true
@ -34,9 +35,4 @@ body:
label: 💡 动机
description: 描述你提出该feature的动机以及没有这项feature对你的使用造成了怎样的影响。
placeholder: |
我需要这个功能是因为...
- type: textarea
attributes:
label: 📚 附加信息
description: 如果有其他相关信息,如屏幕截图、错误日志或相关文档,请在这里提供。
我需要这个功能是因为...

37
.github/ISSUE_TEMPLATE/feature_en.yml vendored Normal file
View File

@ -0,0 +1,37 @@
name: 🚀 (English)Feature request
description: Propose new ideas or suggestions for the project.
title: 🚀[Feature] Please enter a title
labels: enhancement
body:
- type: markdown
attributes:
value: |
📝 **Please fill in a concise and clear title in the `title` above**, the format is suggested as: 🚀[Feature] Short description.
For example: 🚀[Feature] Add xx live recording.
- type: checkboxes
attributes:
label: ⚠️ Search for similar issues
description: >
🔍 [Click here to search historical issues](https://github.com/ihmily/DouyinLiveRecorder/issues?q=is%3Aissue) using keywords to ensure there are no duplicate issues.
options:
- label: I have searched the issues and found no similar issues
required: true
- type: textarea
attributes:
label: 📜 Feature description
description: Please describe in detail the feature you would like to add, including how it should work and what its expected outcomes are.
placeholder: |
Feature description:
- type: textarea
attributes:
label: 🌐 Example (Optional)
description: If possible, provide examples, screenshots, or related URLs related to the feature.
placeholder: |
Live room example URL:
`https://www.example.com/live/xxxx`
- type: textarea
attributes:
label: 💡 Motivation
description: Describe the motivation behind your feature request and how not having this feature impacts your use of the project.
placeholder: |
I need this feature because...

63
.github/ISSUE_TEMPLATE/question.yml vendored Normal file
View File

@ -0,0 +1,63 @@
name: ❓ Question
description: 对程序使用有疑问?在这里提出你的问题。
title: ❓[Question] 请输入标题
labels: question
body:
- type: markdown
attributes:
value: |
📝 **请在上方的`title`中填写一个简洁明了的问题标题**。这将帮助其他人快速理解你的问题。
例如:❓[Question] 如果设置单个直播间的录制清晰度。
- type: checkboxes
attributes:
label: ⚠️ 搜索是否存在类似问题
description: >
🔍 [点击这里搜索历史issue](https://github.com/ihmily/DouyinLiveRecorder/issues?q=is%3Aissue) 使用关键词搜索,看看是否已经有人问过类似的问题。
options:
- label: 我已经搜索过issues没有找到相似的问题
required: true
- type: dropdown
attributes:
label: 🔧 运行方式
description: 请选择你是如何运行程序的。
options:
- 直接运行的exe文件
- 使用源代码运行
- 使用docker运行
validations:
required: true
- type: dropdown
attributes:
label: 🐍 如果是使用源代码运行请选择你的Python环境版本
description: 请选择你运行程序的Python版本。
options:
- Python 3.10
- Python 3.11
- Python 3.12
- Python 3.13
- Other (请在问题中说明)
validations:
required: false
- type: dropdown
attributes:
label: 💻 请选择你的系统环境
description: 请选择你运行程序的具体系统版本。
options:
- Windows 10
- Windows 11
- macOS
- Ubuntu
- CentOS
- Fedora
- Debian
- Other (请在问题中说明)
validations:
required: true
- type: textarea
attributes:
label: 🤔 问题详情
description: 请提供与你的问题相关的所有详细信息。
placeholder: |
你的问题具体是关于什么?
validations:
required: true

63
.github/ISSUE_TEMPLATE/question_en.yml vendored Normal file
View File

@ -0,0 +1,63 @@
name: ❓ (English)Question
description: Have questions about using the program? Ask them here.
title: ❓[Question] Please enter a title
labels: question
body:
- type: markdown
attributes:
value: |
📝 **Please fill in a concise and clear question title in the `title` above**. This will help others quickly understand your question.
For example: ❓[Question] How to set the recording quality for a single live room.
- type: checkboxes
attributes:
label: ⚠️ Search for similar issues
description: >
🔍 [Click here to search historical issues](https://github.com/ihmily/DouyinLiveRecorder/issues?q=is%3Aissue) see if your question has already been asked.
options:
- label: I have searched the issues and found no similar questions
required: true
- type: dropdown
attributes:
label: 🔧 How did you run the program?
description: Please select how you ran the program.
options:
- Executable file run directly
- Running with source code
- Running with docker
validations:
required: true
- type: dropdown
attributes:
label: 🐍 If running with source code, please select your Python environment version
description: Please select the Python version you used to run the program.
options:
- Python 3.10
- Python 3.11
- Python 3.12
- Python 3.13
- Other (please specify in the question)
validations:
required: false
- type: dropdown
attributes:
label: 💻 Please select your system environment
description: Please select the specific system version you are running the program on.
options:
- Windows 10
- Windows 11
- macOS
- Ubuntu
- CentOS
- Fedora
- Debian
- Other (please specify in the question)
validations:
required: true
- type: textarea
attributes:
label: 🤔 Question details
description: Please provide all the details relevant to your question.
placeholder: |
What is your question about?
validations:
required: true