New: Issue template

Standardized Issue Format
This commit is contained in:
PJ568 2024-04-28 11:14:43 +08:00
parent 2a0ad19bc5
commit 1d525d6be4
5 changed files with 156 additions and 0 deletions

View File

@ -0,0 +1,45 @@
---
name: Bug 和问题反馈
about: 请按照模板填写 Bug 和问题反馈,否则你的 Issue 或会被直接关闭。
title: "[Bug]: 请简要描述遇到的问题"
labels: ["question"]
---
> 确保你在提交 Bug 和问题反馈之前仔细阅读了 [README 文档](https://github.com/josStorer/RWKV-Runner/blob/master/README_ZH.md) ,和 [GitHub issues](https://github.com/josStorer/RWKV-Runner/issues) 来了解你的疑问是否已经被他人提出过。
### Bug描述
简洁清晰地描述你遇到的问题是什么。
### 系统与环境
列出你的环境和 RWKV-Runner 的版本和配置。
- 操作系统版本:
- RWKV-Runner 版本:
- 部署方案:
- 采用的模型:
- Python 版本:
- 等……
### 复现方式
列出复现这个问题的步骤,如:
1. 访问‘...
2. 点击’...
3. 下拉到‘...
4. 运行‘...
5. 出现‘...’的错误
### 期望行为
简洁清晰地描述没有这个情况下你期望得到的结果。
### log 和截图
如果可以的话,请附上 log 和几张截图来帮助说明你遇到的问题。
### 额外上下文
附上与问题有关的其他上下文信息。

View File

@ -0,0 +1,45 @@
---
name: Bugs and Issues Reporting
about: Please fill in the template for bug reports and issues; otherwise, your Issue may be closed directly.
title: "[Bug]: Briefly describe the encountered issue"
labels: ["question"]
---
> Ensure that you have carefully read the [README document](https://github.com/josStorer/RWKV-Runner/blob/master/README_ZH.md) and checked existing [GitHub issues](https://github.com/josStorer/RWKV-Runner/issues) before submitting a bug or issue to avoid duplicates.
### Bug Description
Concisely state the problem you have encountered.
### System and Environment
List your environment details and the version/configuration of RWKV-Runner.
- Operating System:
- RWKV-Runner Version:
- Deployment Method:
- Model Used:
- Python Version:
- etc...
### Reproduction Steps
Provide the steps to reproduce the issue, e.g.:
1. Visit '...'
2. Click on '...'
3. Scroll down to '...'
4. Run '...'
5. Encounter error '...'
### Expected Behavior
Clearly describe the outcome you expected without this issue.
### Logs and Screenshots
If possible, attach logs and a few screenshots to help illustrate the problem.
### Additional Context
Include any other relevant context about the problem.

14
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,14 @@
blank_issues_enabled: true
contact_links:
- name: Bug and Issue Report
url: https://github.com/josStorer/RWKV-Runner/issues/new?template=bug_and_issue_report.md
about: Please follow this template if you are reporting a bug, or your issue may be closed without further notice.
- name: Bug 和问题反馈
url: https://github.com/josStorer/RWKV-Runner/issues/new?template=Bug_和问题反馈.md
about: 请按照模板填写 Bug 和问题反馈,否则你的 Issue 或会被直接关闭。
- name: Feature Request
url: https://github.com/josStorer/RWKV-Runner/issues/new?template=feature_request.md
about: Please follow this template if you are requesting a new feature, or your issue may be closed without further notice.
- name: 功能建议
url: https://github.com/josStorer/RWKV-Runner/issues/new?template=功能建议.md
about: 请按照模板填写功能建议,否则你的 Issue 或会被直接关闭。

View File

@ -0,0 +1,26 @@
---
name: Feature Request
about: Please follow the template when submitting a feature request, otherwise your issue may be closed directly.
title: "[FEAT]: Briefly describe the desired feature"
labels: ["enhancement"]
---
> Please ensure that you have carefully read the [README document](https://github.com/josStorer/RWKV-Runner/blob/master/README.md) and checked [GitHub issues](https://github.com/josStorer/RWKV-Runner/issues) to see if your suggestion has already been proposed by someone else before submitting a feature request.
### Is your feature request related to a problem? Please describe
Concisely explain the problem you encountered (e.g., "When using..., I encountered...").
### Describe the solution you'd like
Clearly state the outcome you would like the proposed solution to achieve.
### Alternatives you've considered
Briefly outline any alternative solutions or features you've considered.
### Additional context
Operating System and version:
Software version:
Log:

26
.github/ISSUE_TEMPLATE/功能建议.md vendored Normal file
View File

@ -0,0 +1,26 @@
---
name: 功能建议
about: 请按照模板填写功能建议,否则你的 Issue 或会被直接关闭。
title: "[FEAT]: 请简要描述欲加的功能"
labels: ["enhancement"]
---
> 确保你在提交功能建议之前仔细阅读了 [README 文档](https://github.com/josStorer/RWKV-Runner/blob/master/README_ZH.md) ,和 [GitHub issues](https://github.com/josStorer/RWKV-Runner/issues) 来了解你的建议是否已经被他人提出过。
### 你的功能建议是否与某使用问题相关?请详述
简洁清晰地描述你遇到的问题是什么(如:我在使用...的时候遇到了...)。
### 描述你想要的解决方案
简洁清晰地描述你想要的解决方案可以达到的效果。
### 描述你考虑过的替代办法
简洁清晰地描述你考虑过的替代解决方案或是新功能。
### 额外上下文
操作系统及版本:
软件版本:
log