From f94a145e1ab17839bda2ed70f6b4537307970109 Mon Sep 17 00:00:00 2001 From: Muhammad Awad Date: Mon, 23 Jun 2025 19:48:55 -0400 Subject: [PATCH] Add issue templates --- .../ISSUE_TEMPLATE/documentation-fixes.yml | 14 ++++ .github/ISSUE_TEMPLATE/feature-suggestion.yml | 26 ++++++ .github/ISSUE_TEMPLATE/issue-report.yml | 79 +++++++++++++++++++ 3 files changed, 119 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/documentation-fixes.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-suggestion.yml create mode 100644 .github/ISSUE_TEMPLATE/issue-report.yml diff --git a/.github/ISSUE_TEMPLATE/documentation-fixes.yml b/.github/ISSUE_TEMPLATE/documentation-fixes.yml new file mode 100644 index 0000000..9928a08 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation-fixes.yml @@ -0,0 +1,14 @@ +name: Documentation Fixes +description: Documentation errors can be reported here. +title: "[Documentation]: " +body: +- type: textarea + attributes: + label: Description of errors + validations: + required: true +- type: textarea + attributes: + label: Attach any links, screenshots, or additional evidence you think will be helpful. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-suggestion.yml b/.github/ISSUE_TEMPLATE/feature-suggestion.yml new file mode 100644 index 0000000..8b52353 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-suggestion.yml @@ -0,0 +1,26 @@ +name: Feature Suggestion +description: Suggest an additional functionality, or new way of handling an existing functionality. +title: "[Feature]: " + +body: +- type: markdown + attributes: + value: | + Thank you for taking the time to make a suggestion! + +- type: textarea + attributes: + label: Suggestion Description + description: Describe your suggestion. + validations: + required: true +- type: input + attributes: + label: Operating System + description: (Optional) If this is for a specific OS, you can mention it here. + placeholder: "e.g. Ubuntu" +- type: input + attributes: + label: GPU + description: (Optional) If this is for a specific GPU or GPU family, you can mention it here. + placeholder: "e.g. MI300X" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/issue-report.yml b/.github/ISSUE_TEMPLATE/issue-report.yml new file mode 100644 index 0000000..6874984 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue-report.yml @@ -0,0 +1,79 @@ +name: Issue Report +description: File a report for ROCm related issues on Linux and Windows. For issues pertaining to documentation or non-bug related, please open a blank issue located below. +title: "[Issue]: " + +body: +- type: markdown + attributes: + value: | + Thank you for taking the time to fill out this report! + + You can acquire your OS, CPU, GPU (for filling out this report) with the following commands: + + Linux: + ``` + echo "OS:" && cat /etc/os-release | grep -E "^(NAME=|VERSION=)"; + echo "CPU: " && cat /proc/cpuinfo | grep "model name" | sort --unique; + echo "GPU:" && /opt/rocm/bin/rocminfo | grep -E "^\s*(Name|Marketing Name)"; + ``` + + Windows: + ``` + (Get-WmiObject Win32_OperatingSystem).Version + (Get-WmiObject win32_Processor).Name + (Get-WmiObject win32_VideoController).Name + ``` +- type: textarea + attributes: + label: Problem Description + description: Describe the issue you encountered. + validations: + required: true +- type: input + attributes: + label: Operating System + description: What is the name and version number of the OS? + placeholder: "e.g. Ubuntu 22.04.3 LTS (Jammy Jellyfish)" + validations: + required: true +- type: input + attributes: + label: CPU + description: What CPU did you encounter the issue on? + placeholder: "e.g. AMD Ryzen 9 5900HX with Radeon Graphics" + validations: + required: true +- type: input + attributes: + label: GPU + description: What GPU(s) did you encounter the issue on? + placeholder: "e.g. AMD Instinct MI300X" + validations: + required: true +- type: input + attributes: + label: ROCm Version + description: What version(s) of ROCm did you encounter the issue on? + placeholder: "e.g. ROCm 6.3.1" + validations: + required: true +- type: textarea + attributes: + label: Steps to Reproduce + description: (Optional) Detailed steps to reproduce the issue. + validations: + required: false + +- type: textarea + attributes: + label: (Optional for Linux users) Output of /opt/rocm/bin/rocminfo --support + description: The output of rocminfo --support could help to better address the problem. + validations: + required: false + +- type: textarea + attributes: + label: Additional Information + description: (Optional) Any additional information that is relevant, e.g. relevant environment variables, dockerfiles, log files, dmesg output (on Linux), etc. + validations: + required: false \ No newline at end of file