diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 2bbf60e..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Bug report -about: Report code related issues -title: "[BUG]" -labels: bug -assignees: '' - ---- - -**Disclaimer:** Github Issues are **only** for code related bugs. If you do not understand how to startup or use TabbyAPI, please ask in the [Discord Server](https://discord.gg/sYQxnuD7Fj) - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Logs** -If applicable, add logs and tracebacks to help explain your problem. - -**System info** (Bugs without this information will go lower on our priority list!) - - OS: [ex. Windows] - - Python version: [ex. 3.11] - - CUDA/ROCm version: [ex. 12.x] - - Python version: [ex. 3.11] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000..c520e24 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,97 @@ +name: Bug report +description: Report code related issues +title: "[BUG]" +labels: bug +body: + +- type: markdown + attributes: + value: | + ### Disclaimer: + Github Issues are **only** for code related bugs. + If you do not understand how to startup or use TabbyAPI, please ask in the [Discord Server](https://discord.gg/sYQxnuD7Fj) + +- type: dropdown + attributes: + label: OS + options: + - Windows + - Linux + validations: + required: true + +- type: dropdown + attributes: + label: GPU Library + description: Ex. CUDA, ROCm + options: + - CUDA 12.x + - CUDA 11.8 + - AMD ROCm + validations: + required: true + +- type: dropdown + attributes: + label: Python version + options: + - '3.12' + - '3.11' + - '3.10' + validations: + required: true + +- 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 steps + description: Walk us through how the bug occurred and how to make it happen. + validations: + required: true + +- type: textarea + attributes: + label: Expected behavior + description: What was expected to happen? + validations: + required: true + +- type: textarea + attributes: + label: Logs + description: If applicable, add logs and tracebacks to help explain your problem. + validations: + required: false + +- type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here. + validations: + required: false + +- type: checkboxes + attributes: + label: Acknowledgements + description: Before submitting this issue, please make sure you have completed the following checklist. + options: + - label: I have looked for similar issues before submitting this one. + required: true + - label: I have read the disclaimer, and this issue is related to a code bug. If I have a question, I will use the Discord server. + required: true + - label: I understand that the developers have lives and my issue will be answered when possible. + required: true + - label: I understand the developers of this program are human, and I will ask my questions politely. + required: true + +- type: markdown + attributes: + value: | + ## Thanks! + Well-formatted issues improve TabbyAPI and make the development process smoother. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index e771a8d..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Feature request -about: Suggest a new idea -title: "[REQUEST]" -labels: '' -assignees: '' - ---- - -**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. - -**Why should this feature be added?** -An explanation of why the feature should be added. Please be as specific as possible to help us understand the reasoning. - -**Examples** -Examples of the feature in action and its significance compared to not having the feature. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000..9cf3d8b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,69 @@ +name: Feature request +description: Suggest a new idea +title: "[REQUEST]" +body: + +- type: textarea + attributes: + label: Problem + description: Is the feature request related to a problem? If so, please describe. + placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: false + +- type: textarea + attributes: + label: Solution + description: Describe the solution you'd like. + placeholder: A clear and concise description of what you want to happen. + validations: + required: true + +- type: textarea + attributes: + label: Alternatives + description: What alternative options did you consider? + validations: + required: false + +- type: textarea + attributes: + label: Explanation + description: Why should this feature be added? + validations: + required: true + +- type: textarea + attributes: + label: Examples + description: | + Examples of the feature in action and its significance. + + Not required, but will make your request easier to understand. + validations: + required: false + +- type: textarea + attributes: + label: Additional context + description: Anything else to add? + validations: + required: false + +- type: checkboxes + attributes: + label: Acknowledgements + description: Before submitting this issue, please make sure you have completed the following checklist. + options: + - label: I have looked for similar requests before submitting this one. + required: true + - label: I understand that the developers have lives and my issue will be answered when possible. + required: true + - label: I understand the developers of this program are human, and I will make my requests politely. + required: true + +- type: markdown + attributes: + value: | + ## Thanks! + Well-formatted issues improve TabbyAPI and make the development process smoother.