From 2c1c567a31855a817641a3abbd406a0d75364a93 Mon Sep 17 00:00:00 2001 From: Aryan Dani Date: Wed, 30 Apr 2025 18:28:17 +0530 Subject: [PATCH 1/2] feat: Replace markdown bug report with GitHub issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 26 ---------- .github/ISSUE_TEMPLATE/bug_report.yml | 70 +++++++++++++++++++++++++++ 2 files changed, 70 insertions(+), 26 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index c61ccfa..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,26 +0,0 @@ -***[Remove this]The issue would be closed without notice and be considered spam if the template is not followed.*** - -**Describe the bug** -A clear and concise description of what the bug is. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Error Message** - -`` - -**Desktop (please complete the following information):** - - OS: [e.g. Windows] - - Version [e.g. 22] - - GPU - - CPU - -**Additional context** -Add any other context about the problem here. - -**Confirmation (Mandatory)** -- [ ] I have followed the template -- [ ] This is not a query about how to increase performance -- [ ] I have checked the issues page, and this is not a duplicate - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..f30fd65 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,70 @@ +# @format + +name: Bug Report +description: File a bug report to help us improve +title: "[Bug]: " +labels: ["bug", "triage"] +assignees: [] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + value: "A bug happened!" + validations: + required: true + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: Please provide detailed steps to reproduce the behavior. + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + - type: dropdown + id: os + attributes: + label: Operating System + description: What operating system are you using? + options: + - Windows + - macOS + - Linux + validations: + required: true + - type: dropdown + id: gpu-backend + attributes: + label: GPU Backend + description: Which GPU backend were you using (if applicable)? + options: + - CUDA (NVIDIA) + - DirectML (AMD/Intel/NVIDIA) + - CPU Only + - Not Applicable + validations: + required: false # Make optional as not all issues might be GPU related + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](link/to/code_of_conduct.md) + options: + - label: I agree to follow this project's Code of Conduct + required: true From 9c42993d0c63e90041ad709be8973cb1ae70cba8 Mon Sep 17 00:00:00 2001 From: Aryan Hardik Dani Date: Sat, 3 May 2025 12:41:27 +0530 Subject: [PATCH 2/2] Update bug report template: clarify GPU backend optionality and update Code of Conduct reference --- .github/ISSUE_TEMPLATE/bug_report.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index f30fd65..7fdc727 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -4,7 +4,7 @@ name: Bug Report description: File a bug report to help us improve title: "[Bug]: " labels: ["bug", "triage"] -assignees: [] +assignees: [] body: - type: markdown attributes: @@ -53,7 +53,7 @@ body: - CPU Only - Not Applicable validations: - required: false # Make optional as not all issues might be GPU related + required: false - type: textarea id: logs attributes: @@ -64,7 +64,7 @@ body: id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](link/to/code_of_conduct.md) + description: By submitting this issue, you agree to follow our [Collaboration Guidelines](CONTRIBUTING.md) options: - - label: I agree to follow this project's Code of Conduct + - label: I agree to follow this project's Collaboration Guidelines required: true