Skip to content

Commit 20f3087

Browse files
committed
Merge branch 'DDK-189/ori/github-templates' into 'develop'
Add GitHub issue templates See merge request ComputeAorta/oneapi-construction-kit!98
2 parents 06cd085 + b6b54e9 commit 20f3087

File tree

3 files changed

+144
-0
lines changed

3 files changed

+144
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yaml

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Bug
2+
description: Open a bug report
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for taking the time to fill out this bug report. Please provide the following details so that we can resolve the issue in an efficient and appropriate manner.
9+
- type: markdown
10+
attributes:
11+
value: |
12+
By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/codeplaysoftware/oneapi-construction-kit/blob/main/CODE_OF_CONDUCT.md).
13+
- type: markdown
14+
attributes:
15+
value: |
16+
We ask that you check to see if a similar bug report has already been opened in [Issues](https://github.com/codeplaysoftware/oneapi-construction-kit/labels/bug).
17+
- type: input
18+
id: version
19+
attributes:
20+
label: Version
21+
description: What version(s) of the project are you using?
22+
placeholder: 2.0.0
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: expected
27+
attributes:
28+
label: What behaviour are you expecting?
29+
description: Describe the behaviour you're expecting from the project, including any relevant compilation options, runtime flags, input/output values, etc.
30+
placeholder: Describe the expected behaviour.
31+
validations:
32+
required: true
33+
- type: textarea
34+
id: actual
35+
attributes:
36+
label: What actual behaviour are you seeing?
37+
description: Describe the actual behaviour you're seeing from the project, including any relevant crash logs, error logs, test failures, incorrect output values, etc.
38+
placeholder: Describe the actual behaviour.
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: steps
43+
attributes:
44+
label: What steps are required to reproduce the bug?
45+
description: Provide as much context as you can and describe the steps required to *reproduce* the bug, so that maintainers can recreate the issue.
46+
placeholder: Describe the steps to reproduce the bug.
47+
validations:
48+
required: true
49+
- type: textarea
50+
id: testcase
51+
attributes:
52+
label: Minimal test case
53+
description: If possible, provide a minimal test case demonstrating the bug. This should be a self-contained submission of code that will reproduce the bug without any extraneous effects, making it easier for us to isolate where the problem is.
54+
placeholder: Provide a minimal test case.
55+
validations:
56+
required: false
57+
- type: textarea
58+
id: extra
59+
attributes:
60+
label: Anything else we should know?
61+
description: If there's any other relevant information we should know that may help us in resolving your issue, please include it here.
62+
placeholder: Detail any other relevant information.
63+
validations:
64+
required: false
+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Enhancement
2+
description: Suggest an enhancement
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for taking the time to suggest an enhancement for the project. Please provide the following details so that we can fully understand and handle your suggestion in an efficient and appropriate manner.
9+
- type: markdown
10+
attributes:
11+
value: |
12+
By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/codeplaysoftware/oneapi-construction-kit/blob/main/CODE_OF_CONDUCT.md).
13+
- type: markdown
14+
attributes:
15+
value: |
16+
We ask that you check to see if a similar enhancement has already been suggested by someone else in [Issues](https://github.com/codeplaysoftware/oneapi-construction-kit/issues?q=label%3Aenhancement). It may be that your requested feature may be covered by another feature.
17+
- type: textarea
18+
id: overview
19+
attributes:
20+
label: Brief overview
21+
description: Give a brief overview of what you are proposing to be added to the project. Please include any relevant details such as graphics, code snippets, etc, and describe why your suggested approach is required.
22+
placeholder: Give a brief overview of the enhancement.
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: expected
27+
attributes:
28+
label: What behaviour are you expecting?
29+
description: Describe the behaviour you'd like to see in the project, including any relevant compilation options, runtime flags, input/output values, etc.
30+
placeholder: Describe the expected behaviour.
31+
validations:
32+
required: true
33+
- type: textarea
34+
id: actual
35+
attributes:
36+
label: What current behaviour are you seeing?
37+
description: Describe the current behaviour of the project and how it differs from the behaviour you're expecting to see.
38+
placeholder: Describe the current behaviour.
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: extra
43+
attributes:
44+
label: Anything else we should know?
45+
description: If there's any other relevant information we should know that may help us in understanding and addressing your suggestion, please include it here.
46+
placeholder: Detail any other relevant information.
47+
validations:
48+
required: false

.github/ISSUE_TEMPLATE/question.yaml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Question
2+
description: Ask a question
3+
labels: ["question"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for your interest in the project. Please provide the following details so that we can address your query in an efficient and appropriate manner.
9+
- type: markdown
10+
attributes:
11+
value: |
12+
By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/codeplaysoftware/oneapi-construction-kit/blob/main/CODE_OF_CONDUCT.md).
13+
- type: markdown
14+
attributes:
15+
value: |
16+
We ask that you check to see if a similar question or concern has been raised in [Issues](https://github.com/codeplaysoftware/oneapi-construction-kit/issues?q=label%3Aquestion). It may be that your question has already been previously answered.
17+
- type: input
18+
id: version
19+
attributes:
20+
label: Version
21+
description: What version(s) of the project are you using?
22+
placeholder: 2.0.0
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: extra
27+
attributes:
28+
label: What is your question or problem?
29+
description: Describe your question or problem with as much context and detail as you can. If there's any relevant information we should know that may help us in assisting you, please include it here.
30+
placeholder: Describe your question or problem.
31+
validations:
32+
required: true

0 commit comments

Comments
 (0)