lywsvip/StreamCap
1
0
Fork 0
mirror of https://github.com/ihmily/StreamCap.git synced 2026-05-22 19:59:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: add issue templates and pull request template

Browse Source
This commit is contained in:
ihmily
2025-03-28 19:29:04 +08:00
parent 436524ff94
commit 49e2ceaf2b
7 changed files with 423 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
.github/ISSUE_TEMPLATE/bug.yml vendored Normal file
View File

@@ -0,0 +1,87 @@
name: 🐛 Bug report
description: 创建Bug报告以帮助项目改进。
title: 🐛[BUG] 请输入标题
labels: bug
body:
- type: markdown
attributes:
value: |
📝 **请在上方的`title`中填写一个简洁明了的标题**，格式建议为：🐛[Bug] 简短描述。
例如：🐛[Bug] B站某些直播间无法录制。
- type: checkboxes
attributes:
label: ⚠️ 确认是否已存在类似问题
description: >
🔍 [点击这里搜索历史issue](https://github.com/ihmily/StreamCap/issues?q=is%3Aissue)
请确保你的问题没有被报告过。
options:
- label: 我已经搜索过issues，没有找到类似问题
required: true
- type: dropdown
attributes:
label: 🔧 运行方式
description: 请选择你是如何运行程序的。
options:
- 直接运行预构建的程序
- 使用源代码运行
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 (Intel)
- macOS (Apple Silicon)
- Other (请在问题中说明)
validations:
required: true
- type: checkboxes
attributes:
label: ⚠️ 确认是否已经重试多次
description: >
有时可能是你的设备或者网络问题导致的。
options:
- label: 我已经尝试过多次，仍然出现问题
required: true
- type: textarea
attributes:
label: 🕹 复现步骤
description: |
**⚠️ 不能复现将会关闭issue.**
请按照以下格式填写：
1. 录制的直播间地址是...
2. 使用的录制格式是...
3. ...
placeholder: |
1. ...
2. ...
3. ...
validations:
required: true
- type: textarea
attributes:
label: 😯 问题描述
description: 详细描述出现的问题，或提供有关截图。
validations:
required: true
- type: textarea
attributes:
label: 📜 错误信息
description: 如果有，请贴出相关的日志错误信息或者截图。
validations:
required: false

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

@@ -0,0 +1,87 @@
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/StreamCap/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
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 (Intel)
- macOS (Apple Silicon)
- 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

38
.github/ISSUE_TEMPLATE/feature.yml vendored Normal file
View File

@@ -0,0 +1,38 @@
name: 🚀 Feature request
description: 提出你对项目的新想法或建议。
title: 🚀[Feature] 请输入标题
labels: enhancement
body:
- type: markdown
attributes:
value: |
📝 **请在上方的`title`中填写一个简洁明了的标题**，格式建议为：🚀[Feature] 简短描述。
例如：🚀[Feature] 添加xx直播录制。
- type: checkboxes
attributes:
label: ⚠️ 搜索是否存在类似issue
description: >
🔍 [点击这里搜索历史issue](https://github.com/ihmily/StreamCap/issues?q=is%3Aissue) 使用关键词搜索，确保没有重复的issue。
options:
- label: 我已经搜索过issues，没有发现相似issue
required: true
- type: textarea
attributes:
label: 📜 功能描述
description: 请详细描述你希望添加的功能，包括它的工作方式和预期效果。
placeholder: |
功能描述：
- type: textarea
attributes:
label: 🌐 举例(可选)
description: 如果可能，请提供功能相关的示例、截图或相关网址。
placeholder: |
直播间示例地址：
`https://www.example.com/live/xxxx`
- type: textarea
attributes:
label: 💡 动机
description: 描述你提出该feature的动机，以及没有这项feature对你的使用造成了怎样的影响。
placeholder: |
我需要这个功能是因为...

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/StreamCap/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...

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

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

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

@@ -0,0 +1,59 @@
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/StreamCap/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
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 (Intel)
- macOS (Apple Silicon)
- 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

56
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,56 @@
### 📜 标题（Title）
**请提供这个Pull Request中提议的更改的简洁描述：**
<!-- Please provide a succinct description of the changes proposed in this pull request:. -->
-
### 🔍 描述（Description）
**请描述这个PR做了什么/为什么这些更改是必要的：**
<!-- Please describe what this PR does / why these changes are necessary: -->
-
### 📝 类型（Type of Change）
**这个PR引入了哪种类型的更改？（请勾选所有适用的选项）**
<!-- What type of change does this PR introduce? (Check all that apply) -->
- [ ] 修复Bug <!-- Bugfix -->
- [ ] 新功能 <!-- Feature -->
- [ ] 代码风格更新（格式化，局部变量） <!-- Code style update (formatting, local variables) -->
- [ ] 重构（改进代码结构） <!-- Refactoring (improving code structure) -->
- [ ] 构建相关更改（依赖项，构建脚本等） <!-- Build-related changes (dependencies, build scripts, etc.) -->
- [ ] 其他：_请描述_ <!-- Other: _Please describe_ -->
### 🏗️ 测试（Testing）
**请描述您已经进行的测试：**
<!-- Please describe the tests you've done: -->
-
**如果适用，请提供测试更改的说明：**
<!-- If applicable, provide instructions for testing your changes -->
-
### 📋 检查清单（Checklist）
在您创建这个PR之前，请确保以下所有框都被勾选，方法是在每个框中放置一个`x`：
<!-- Before you create this PR, please ensure the following boxes are checked by placing an `x` in each box: -->
- [ ] 我已经阅读了**贡献指南**文档 <!-- I have read the **CONTRIBUTING** document. -->
- [ ] 我的更改没有产生新的警告 <!-- My changes generate no new warnings. -->
- [ ] 我已经添加了覆盖我更改的测试 <!-- I have added tests to cover my changes.. -->
- [ ] 我已经相应地更新了文档（如果适用） <!-- I have updated the documentation accordingly (if applicable). -->
- [ ] 我遵循了这个项目的代码风格 <!-- I have followed the code style of this project. -->
**注意：** 这个PR在所有复选框被勾选之前不会被合并。
<!-- **Note:** This PR will not be merged until all checkboxes are ticked. -->
---
**感谢您的贡献！**
<!-- Thank you for your contribution! -->