-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[ci]: update issue template & security & license #1617
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,55 @@ | ||
| name: 🐞 Bug report | ||
| description: Create a report to help us reproduce and fix the bug | ||
| title: "[Bug] " | ||
| labels: ['Bug'] | ||
|
|
||
| name: "\U0001F41B Bug / help" | ||
| description: Create a report to help us improve the ktransformers project | ||
| labels: ["bug", "pending"] | ||
| 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. | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Issues included in **[FAQs](https://github.com/kvcache-ai/ktransformers/issues/1608)** or those with **insufficient** information may be closed without a response. | ||
| 已经包含在 **[常见问题](https://github.com/kvcache-ai/ktransformers/issues/1608)** 内或提供信息**不完整**的 issues 可能不会被回复。 | ||
|
|
||
| - type: checkboxes | ||
| id: reminder | ||
| attributes: | ||
| label: Reminder | ||
| description: | | ||
| Please ensure you have read the above rules carefully and searched the existing issues (including FAQs). | ||
| 请确保您已经认真阅读了上述规则并且搜索过现有的 issues(包括常见问题)。 | ||
|
|
||
| options: | ||
| - label: I have read the above rules and searched the existing issues. | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: system-info | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: System Info | ||
| description: | | ||
| Please share your system info with us. You can run the command **lscpu**, ** nvidia-smi ** etc. and copy-paste its output below. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There are extra spaces around Please share your system info with us. You can run the command **lscpu**, **nvidia-smi** etc. and copy-paste its output below. |
||
| 请提供您的系统信息。您可以在命令行运行 **lscpu**, **nvidia-smi** 等命令,并将其输出复制到该文本框中。 | ||
|
|
||
| placeholder: ktransformers version,sglang version, platform, python version, cpu info, GPU/NPU info ... | ||
|
|
||
| - type: textarea | ||
| id: reproduction | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: Reproduction | ||
| description: | | ||
| Please provide entry arguments, error messages and stack traces that reproduces the problem. | ||
| 请提供入口参数,错误日志以及异常堆栈以便于我们复现问题。 | ||
|
|
||
| value: | | ||
| ```text | ||
| Put your message 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 | ||
| - type: textarea | ||
| id: others | ||
| validations: | ||
| required: false | ||
| attributes: | ||
| label: Others | ||
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,41 @@ | ||
| name: 🚀 Feature request | ||
| description: Suggest an idea for this project | ||
| title: "[Feature] " | ||
|
|
||
| name: "\U0001F680 Feature request" | ||
| description: Submit a request for a new feature | ||
| labels: ["enhancement", "pending"] | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| 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. | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Please do not create issues that are not related to new features under this category. | ||
| 请勿在此分类下创建和新特性无关的 issues。 | ||
|
|
||
| - type: checkboxes | ||
| id: reminder | ||
| attributes: | ||
| label: Reminder | ||
| description: | | ||
| Please ensure you have read the above rules carefully and searched the existing issues. | ||
| 请确保您已经认真阅读了上述规则并且搜索过现有的 issues。 | ||
|
|
||
| options: | ||
| - label: I have read the above rules and searched the existing issues. | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: description | ||
| validations: | ||
| required: true | ||
| attributes: | ||
| label: Description | ||
| description: | | ||
| A clear and concise description of the feature proposal. | ||
| 请详细描述您希望加入的新功能特性。 | ||
|
|
||
| - type: textarea | ||
| id: contribution | ||
| validations: | ||
| required: false | ||
| attributes: | ||
| label: Pull Request | ||
| description: | | ||
| Have you already created the relevant PR and submitted the code? | ||
| 您是否已经创建了相关 PR 并提交了代码? | ||
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Reporting Security Issues | ||
|
|
||
| To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://github.com/kvcache-ai/ktransformers/security/advisories/new) tab. | ||
|
|
||
| We will send a response indicating the next steps in handling your report. After the initial reply to your report, the security team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance. | ||
|
|
||
| Report security bugs in third-party modules to the person or team maintaining the module. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency and easier filtering of issues, it's helpful to have a default title prefix for bug reports. Consider adding the
titlefield back.