From c18400fa29c657b5c5cffc999d2eb9a757ddaf64 Mon Sep 17 00:00:00 2001 From: Brian Dashore Date: Wed, 4 Sep 2024 08:58:58 -0400 Subject: [PATCH] Issues: Add issue templates (#615) Should help encourage well-formatted issues and make development easier. Signed-off-by: kingbri --- .github/ISSUE_TEMPLATE/bug_report.yaml | 109 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.yaml | 69 +++++++++++++ 3 files changed, 179 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000..99740a7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,109 @@ +name: Bug report +description: Report bugs with the project +title: "[BUG]" +labels: bug +body: + +- type: markdown + attributes: + value: | + ### Disclaimer: + Github Issues are **only** for code related bugs. + Please fill in as many fields as possible so we can understand the relevant parts of the issue. + +- 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: input + attributes: + label: Pytorch version + validations: + required: True + +- type: input + attributes: + label: Model + description: Provide a model if the issue is related to one + placeholder: HF Repo Author/Model Name + validations: + required: False + +- 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 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 ExllamaV2 and make the development process easier. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000..a2a0222 --- /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. Real-world examples are helpful for samplers. + 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 ExllamaV2 and make the development process easier.