Skip to content

Commit

Permalink
[CI] Improve issue templates (#12853)
Browse files Browse the repository at this point in the history
Use YAML & add new bug templates to improve issue triaging.

---------

Co-authored-by: Alexey Sachkov <alexey.sachkov@intel.com>
Co-authored-by: Dmitry Vodopyanov <dmitry.vodopyanov@intel.com>
Co-authored-by: Justin Cai <justincai.lps@gmail.com>
  • Loading branch information
4 people authored Feb 29, 2024
1 parent 2ebc479 commit 0a2e5ad
Show file tree
Hide file tree
Showing 7 changed files with 169 additions and 52 deletions.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Bug report
description: File a bug report to help us improve
labels: ["bug"]
body:
- type: textarea
id: description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
id: how-to-reproduce
attributes:
label: To reproduce
description: Please describe the steps to reproduce the behavior
placeholder: |
1. Include a code snippet that is as short as possible
2. Specify the command which should be used to compile the program
3. Specify the command which should be used to launch the program
4. Indicate what is wrong and what was expected
validations:
required: false
- type: textarea
id: environment
attributes:
label: Environment
description: Please complete the following information
placeholder: |
- OS: [e.g Windows/Linux]
- Target device and vendor: [e.g. Intel GPU]
- DPC++ version: [e.g. commit hash or output of `clang++ --version`]
- Dependencies version: [e.g. the output of `sycl-ls --verbose`]
validations:
required: false
- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context about the problem here
validations:
required: false
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/2-bug-report-cuda.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: CUDA-specific bug report
description: Please use this template in case of CUDA-specific issue
labels: ["bug", "cuda"]
body:
- type: textarea
id: description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
id: how-to-reproduce
attributes:
label: To reproduce
description: Please describe the steps to reproduce the behavior
placeholder: |
1. Include code snippet as short as possible
2. Specify the command which should be used to compile the program
3. Specify the command which should be used to launch the program
4. Indicate what is wrong and what was expected
validations:
required: false
- type: textarea
id: environment
attributes:
label: Environment
description: Please complete the following information
placeholder: |
- OS: [e.g Windows/Linux]
- Target device and vendor: [e.g. Nvidia GPU]
- DPC++ version: [e.g. commit hash or output of `clang++ --version`]
- Dependencies version: [e.g. the output of `nvidia-smi` and `sycl-ls --verbose`]
validations:
required: false
- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context about the problem here
validations:
required: false
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/3-bug-report-hip.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: HIP-specific bug report
description: Please use this template in case of HIP-specific issue
labels: ["bug", "hip"]
body:
- type: textarea
id: description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
id: how-to-reproduce
attributes:
label: To reproduce
description: Please describe the steps to reproduce the behavior
placeholder: |
1. Include code snippet as short as possible
2. Specify the command which should be used to compile the program
3. Specify the command which should be used to launch the program
4. Indicate what is wrong and what was expected
validations:
required: false
- type: textarea
id: environment
attributes:
label: Environment
description: Please complete the following information
placeholder: |
- OS: [e.g Windows/Linux]
- Target device and vendor: [e.g. AMD GPU]
- DPC++ version: [e.g. commit hash or output of `clang++ --version`]
- Dependencies version: [e.g. the output of `rocm-smi` and `sycl-ls --verbose`]
validations:
required: false
- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context about the problem here
validations:
required: false
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/4-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Feature request
description: Suggest an idea/improvement for this project
labels: ["enhancement"]
body:
- type: textarea
id: description
attributes:
label: Is your feature request related to a problem? Please describe
description: |
A clear and concise description of what the problem is.
Include reproducer or code/pseudo-code example.
Include specific environment details where problem occurs.
validations:
required: true
- type: textarea
id: desired-solution
attributes:
label: Describe the solution you would like
description: |
A clear and concise description of what you want to happen.
validations:
required: false
- type: textarea
id: alternative-solution
attributes:
label: Describe alternatives you have considered
description: |
A clear and concise description of any alternative solutions or features
you have considered.
validations:
required: false
- type: textarea
id: additional
attributes:
label: Additional context
description: |
Add any other context about the feature request here.
validations:
required: false
29 changes: 0 additions & 29 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: Ask community a question
url: https://github.com/intel/llvm/discussions/categories/q-a
about: Please use Q&A Discussions category instead of Issues to ask questions
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

0 comments on commit 0a2e5ad

Please sign in to comment.