Skip to content

Commit

Permalink
Merge branch 'DDK-189/ori/github-templates' into 'develop'
Browse files Browse the repository at this point in the history
Add GitHub issue templates

See merge request ComputeAorta/oneapi-construction-kit!98
  • Loading branch information
ori-sky committed Jun 1, 2023
2 parents 06cd085 + b6b54e9 commit 20f3087
Show file tree
Hide file tree
Showing 3 changed files with 144 additions and 0 deletions.
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Bug
description: Open a bug report
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
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.
- type: markdown
attributes:
value: |
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).
- type: markdown
attributes:
value: |
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).
- type: input
id: version
attributes:
label: Version
description: What version(s) of the project are you using?
placeholder: 2.0.0
validations:
required: true
- type: textarea
id: expected
attributes:
label: What behaviour are you expecting?
description: Describe the behaviour you're expecting from the project, including any relevant compilation options, runtime flags, input/output values, etc.
placeholder: Describe the expected behaviour.
validations:
required: true
- type: textarea
id: actual
attributes:
label: What actual behaviour are you seeing?
description: Describe the actual behaviour you're seeing from the project, including any relevant crash logs, error logs, test failures, incorrect output values, etc.
placeholder: Describe the actual behaviour.
validations:
required: true
- type: textarea
id: steps
attributes:
label: What steps are required to reproduce the bug?
description: Provide as much context as you can and describe the steps required to *reproduce* the bug, so that maintainers can recreate the issue.
placeholder: Describe the steps to reproduce the bug.
validations:
required: true
- type: textarea
id: testcase
attributes:
label: Minimal test case
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.
placeholder: Provide a minimal test case.
validations:
required: false
- type: textarea
id: extra
attributes:
label: Anything else we should know?
description: If there's any other relevant information we should know that may help us in resolving your issue, please include it here.
placeholder: Detail any other relevant information.
validations:
required: false
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Enhancement
description: Suggest an enhancement
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
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.
- type: markdown
attributes:
value: |
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).
- type: markdown
attributes:
value: |
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.
- type: textarea
id: overview
attributes:
label: Brief overview
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.
placeholder: Give a brief overview of the enhancement.
validations:
required: true
- type: textarea
id: expected
attributes:
label: What behaviour are you expecting?
description: Describe the behaviour you'd like to see in the project, including any relevant compilation options, runtime flags, input/output values, etc.
placeholder: Describe the expected behaviour.
validations:
required: true
- type: textarea
id: actual
attributes:
label: What current behaviour are you seeing?
description: Describe the current behaviour of the project and how it differs from the behaviour you're expecting to see.
placeholder: Describe the current behaviour.
validations:
required: true
- type: textarea
id: extra
attributes:
label: Anything else we should know?
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.
placeholder: Detail any other relevant information.
validations:
required: false
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Question
description: Ask a question
labels: ["question"]
body:
- type: markdown
attributes:
value: |
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.
- type: markdown
attributes:
value: |
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).
- type: markdown
attributes:
value: |
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.
- type: input
id: version
attributes:
label: Version
description: What version(s) of the project are you using?
placeholder: 2.0.0
validations:
required: true
- type: textarea
id: extra
attributes:
label: What is your question or problem?
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.
placeholder: Describe your question or problem.
validations:
required: true

0 comments on commit 20f3087

Please sign in to comment.