diff --git a/.github/ISSUE_TEMPLATE/-bug-.md b/.github/ISSUE_TEMPLATE/-bug-.md index 0269e4b..7c74c6e 100644 --- a/.github/ISSUE_TEMPLATE/-bug-.md +++ b/.github/ISSUE_TEMPLATE/-bug-.md @@ -1,37 +1,39 @@ ---- -name: "[BUG]" -about: Create a report to help us improve -title: "[BUG]" -labels: bug -assignees: '' +name: 🐞 Bug report +description: Create a report to help us reproduce and fix the bug +title: "[Bug] " +labels: ['Bug'] ---- +body: +- type: checkboxes + attributes: + label: Checklist + options: + - label: 1. I have searched related issues but cannot get the expected help. + - label: 2. The bug has not been fixed in the latest version. + - label: 3. Please note that if the bug-related issue you submitted lacks corresponding environment info and a minimal reproducible demo, it will be challenging for us to reproduce and resolve the issue, reducing the likelihood of receiving feedback. + - label: 4. If the issue you raised is not a bug but a question, please raise a discussion at https://github.com/kvcache-ai/ktransformers/discussions. Otherwise, it will be closed. + - label: 5. To help the community, I will use Chinese/English or attach an Chinese/English translation if using another language. Non-Chinese/English content without translation may be closed. -Checklist -- [ ] I have searched related issues but cannot get the expected help. -- [ ] The bug has not been fixed in the latest version. -- [ ] Please note that if the bug-related issue you submitted lacks corresponding environment info and a minimal reproducible demo, it will be challenging for us to reproduce and resolve the issue, reducing the likelihood of receiving feedback. -- [ ] If the issue you raised is not a bug but a question, please raise a discussion at https://github.com/kvcache-ai/ktransformers/discussions. Otherwise, it will be closed. -- [ ] To help the community, I will use English or attach an English translation if using another language. Non-English content without translation may be closed. - - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Run '...' command. -2. If you modified optimization rules, uploads the file or clarify what have you changed. -3. How did you install KTransformers? (e.g. from source, from whl) -4. KTransformers version (e.g. 0.2.2 or specific commit number) - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Environments(please complete the following information):** -- OS: [e.g. Ubuntu 22.04] -- GPU: [e.g. NVIDIA RTX 4090] -- CPU: [e.g. Intel Xeon Gold 6454S] - -**Additional context** -Add any other context about the problem here. +- type: textarea + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true +- type: textarea + attributes: + label: Reproduction + description: | + What command or script did you run? Which **model** are you using? + placeholder: | + A placeholder for the command. + validations: + required: true +- type: textarea + attributes: + label: Environment + description: | + Please provide necessary environment information here (e.g. OS/GPU/CPU). Otherwise the issue will be close. + placeholder: Environment here. + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/-bug2-.md b/.github/ISSUE_TEMPLATE/-bug2-.md new file mode 100644 index 0000000..85b2180 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/-bug2-.md @@ -0,0 +1,39 @@ +name: 🐞 BUG报告 +description: 创建报告以帮助我们复现并修复BUG +title: "[Bug] " +labels: ['Bug'] + +body: +- type: checkboxes + attributes: + label: 检查清单 + options: + - label: 1. 我已经搜索过相关问题，但未能获得预期的帮助 + - label: 2. 该问题在最新版本中尚未修复 + - label: 3. 请注意，如果您提交的BUG相关 issue 缺少对应环境信息和最小可复现示例，我们将难以复现和定位问题，降低获得反馈的可能性 + - label: 4. 如果您提出的不是bug而是问题，请在讨论区发起讨论 https://github.com/kvcache-ai/ktransformers/discussions。否则该 issue 将被关闭 + - label: 5. 为方便社区交流，我将使用中文/英文或附上中文/英文翻译（如使用其他语言）。未附带翻译的非中文/英语内容可能会被关闭 + +- type: textarea + attributes: + label: 问题描述 + description: 清晰简洁地描述BUG是什么 + validations: + required: true +- type: textarea + attributes: + label: 复现步骤 + description: | + 你运行了什么命令或脚本？使用的是哪个**模型**？ + placeholder: | + 在此处填写命令 + validations: + required: true +- type: textarea + attributes: + label: 环境信息 + description: | + 请提供必要的环境信息（如操作系统/GPU/CPU），否则该 issue 将被关闭 + placeholder: 在此处填写环境信息 + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/-feature-.md b/.github/ISSUE_TEMPLATE/-feature-.md index a4d0271..4ef23c4 100644 --- a/.github/ISSUE_TEMPLATE/-feature-.md +++ b/.github/ISSUE_TEMPLATE/-feature-.md @@ -1,24 +1,23 @@ ---- -name: "[feature]" -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' +name: 🚀 Feature request +description: Suggest an idea for this project +title: "[Feature] " ---- - -Checklist: -- [ ] If the issue you raised is not a bug but a question, please raise a discussion at https://github.com/kvcache-ai/ktransformers/discussions. Otherwise, it will be closed. -- [ ] To help the community, I will use English or attach an English translation if using another language. Non-English content without translation may be closed. - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. +body: +- type: checkboxes + attributes: + label: Checklist + options: + - label: 1. If the issue you raised is not a feature but a question, please raise a discussion at https://github.com/kvcache-ai/ktransformers/discussions. Otherwise, it will be closed. + - label: 2. To help the community, I will use Chinese/English or attach an Chinese/English translation if using another language. Non-English/Chinese content without translation may be closed. +- type: textarea + attributes: + label: Motivation + description: | + A clear and concise description of the motivation of the feature. + validations: + required: true +- type: textarea + attributes: + label: Related resources + description: | + If there is an official code release or third-party implementations, please also provide the information here, which would be very helpful. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/-feature2-.md b/.github/ISSUE_TEMPLATE/-feature2-.md new file mode 100644 index 0000000..571af4a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/-feature2-.md @@ -0,0 +1,23 @@ +name: 🚀 新功能请求 +description: 为项目提出新功能建议 +title: "[Feature] " + +body: +- type: checkboxes + attributes: + label: 检查清单 + options: + - label: 1. 如果您提出的不是新功能而是问题，请在讨论区发起讨论 https://github.com/kvcache-ai/ktransformers/discussions。否则该 issue 将被关闭 + - label: 2. 为方便社区交流，我将使用中文/英文或附上英文/中文翻译（如使用其他语言）。未附带翻译的非英文/中文内容可能会被关闭 +- type: textarea + attributes: + label: 需求背景 + description: | + 清晰简洁地描述该功能的背景需求 + validations: + required: true +- type: textarea + attributes: + label: 相关资源 + description: | + 如果有官方代码实现或第三方实现，请在此提供相关信息，这将非常有帮助 \ No newline at end of file