diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 4dec4e1b16..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Bug report -about: Report a bug you've encountered for further investigation -title: '' -labels: bug -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**Development Environment:** - - Linux Distribution: [e.g. Ubuntu20.04, RHEL8] - - Omniperf Version: [e.g. try `omniperf --version`] - - GPU: [e.g. Mi100, Mi200] - - Custer (if applicable): [e.g. Crusher, ] - -**To Reproduce** -Steps to reproduce the behavior: -1. Run '...' -2. Go to '...' -2. Click on '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**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 0000000000..fd42b0ed20 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,131 @@ +name: Bug Report +description: Report a bug you've encountered for further investigation +title: "[Bug]: " +labels: ["bug", "triage"] +assignees: + - njobypet +body: + - type: markdown + attributes: + value: | + Please complete the following form. + + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + placeholder: e.g. I found the following error when trying to... + validations: + required: true + + - type: markdown + attributes: + value: | + ## Development Environment + + - type: input + id: linux-distro + attributes: + label: Linux Distribution + description: | + What operating system are you using? Hint: + ```shell + echo "OS:" && cat /etc/os-release | grep -E "^(NAME=|VERSION=)" + ``` + placeholder: e.g. Ubuntu 22.04 + validations: + required: true + + - type: input + id: omniperf-version + attributes: + label: Omniperf Version + description: | + What version of Omniperf are you using? Hint: + ```shell + omniperf --version + ``` + placeholder: e.g. 2.1.0 + validations: + required: true + + - type: input + id: gpu + attributes: + label: GPU + description: | + What GPU(s) did you encounter the issue on? Hint: + ```shell + echo "GPU:" && /opt/rocm/bin/rocminfo | grep -E "^\s*(Name|Marketing Name)" + ``` + placeholder: e.g. AMD MI250, AMD MI300X + validations: + required: true + + - type: input + id: rocm-version + attributes: + label: ROCm Version + description: | + What version(s) of ROCm did you encounter the issue on? Deduce from: + ```shell + readlink -f $(which rocprof) + ``` + placeholder: e.g. ROCm 6.0.2 + + - type: input + id: cluster + attributes: + label: Cluster name (if applicable) + description: What is the name of the cluster you are using? + placeholder: e.g. Frontier, El Capitan, etc. + + - type: markdown + attributes: + value: | + ## To Reproduce + + - type: textarea + id: reproducer + attributes: + label: Reproducer + description: Steps to reproduce the behavior + placeholder: | + 1. Run '...' + 2. Go to '...' + 3. Click on '....' + 4. See error + validations: + required: true + + - type: textarea + id: expected-behav + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + placeholder: e.g. I expected the following to happen... + + - type: markdown + attributes: + value: | + ## Other + + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste Omniperf's `log.txt` file. This will be automatically formatted into code, so no need for backticks. + render: shell + + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem. + + - type: textarea + id: context + attributes: + label: Additional Context + description: Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 11fc491ef1..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -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. - -**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 0000000000..d94601b85f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,45 @@ +name: Feature Request +description: Suggest an idea for this project +title: "[Req]: " +labels: ["enhancement", "triage"] +assignees: + - njobypet +body: + - type: markdown + attributes: + value: | + Please complete the following form. + + - type: textarea + id: problem + attributes: + label: Is your feature request related to a problem? + description: A clear and concise description of what the problem is. + placeholder: e.g. I'm always frustrated when... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + placeholder: e.g. I propose that... + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Describe any alternatives you've considered + description: Walk through your thought process and how you arrived at your solution. + placeholder: | + e.g. Some alternative approaches might be: + 1. ... + 2. ... + + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 7429e6325e..0000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Question -about: 'Clarifying questions and uncertainties ' -title: '' -labels: question -assignees: '' - ---- - -**Describe your question** -A clear and concise description of your question and how it came up. - -**Additional context** -Add any other context or screenshots about the question here. diff --git a/.github/ISSUE_TEMPLATE/question.yaml b/.github/ISSUE_TEMPLATE/question.yaml new file mode 100644 index 0000000000..03595df99b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yaml @@ -0,0 +1,23 @@ +name: Question +description: Clarifying questions and uncertainties +labels: ["question"] +body: + - type: markdown + attributes: + value: | + Please complete the following form. + + - type: textarea + id: question + attributes: + label: Describe your question + description: A clear and concise description of your question and how it came up. + placeholder: I was unsure how to ... + validations: + required: true + + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context or screenshots about the question here. \ No newline at end of file