Skip to content

Commit

Permalink
Added issue templates.
Browse files Browse the repository at this point in the history
  • Loading branch information
tal-mi committed Dec 26, 2023
1 parent 05be2db commit 22c63bc
Show file tree
Hide file tree
Showing 3 changed files with 116 additions and 0 deletions.
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug Report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
name: Report a bug or issue
description: Report a bug or issue related to the SDK or its components.
labels: ["bug"]

body:
- type: markdown
attributes:
value: |
**For your security, please make sure you are not attaching any sensitive information such as API keys in your bug report.**
- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: The issue can be reproduced in the attached sample application in the repository.
required: true
- label: I have read the relevant [SDK documentation](https://github.com/SAP/gigya-swift-sdk#sap-cdc-gigya-swift-sdk) and have not found a suitable solution or answer.
required: true
- label: I agree to the terms within the [SAP Code of Conduct](https://github.com/SAP/gigya-swift-sdk/blob/main/CODE_OF_CONDUCT.md).
required: true

- type: textarea
id: description
attributes:
label: Description
description: Provide a clear and concise description of the issue.
placeholder: |
1. Short description...
2. Expected behavior...
3. Actual behavior...
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Reproduction
description: Detail the steps taken to reproduce the issue behavior.
placeholder: |
1. Step 1...
2. Step 2...
3. ...
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other relevant information you think would be useful in describing the issue.
validations:
required: false

- type: input
id: sdk-version
attributes:
label: SDK version
description: We recommend staying updated with the latest version.
validations:
required: true

- type: markdown
id: note
attributes:
value: |
**Note:** In some cases (usually when the issue falls under implementation), you will be required to open a [support ticket](https://me.sap.com/notes/1296527) instead of a publicly viewable bug report. This is to ensure that no sensitive information will be exposed publicly.
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature Request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Feature request
description: Suggest an idea or feature for this project.
labels: ["feature request"]

body:
- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: I have read the relevant [SDK documentation](https://github.com/SAP/gigya-swift-sdk#sap-cdc-gigya-swift-sdk) and have not found a suitable solution.
required: true
- label: I agree to the terms within the [SAP Code of Conduct](https://github.com/SAP/gigya-swift-sdk/blob/main/CODE_OF_CONDUCT.md).
required: true

- type: textarea
id: description
attributes:
label: Describe the problem you'd like to have solved.
description: A clear and concise description of what the problem is.
placeholder: I have a problem when…
validations:
required: true

- type: textarea
id: ideal-solution
attributes:
label: Describe the ideal solution.
description: A clear and concise description of what you want to happen.
validations:
required: true

- type: textarea
id: alternatives-or-workarounds
attributes:
label: Alternatives or workarounds
description: A clear and concise description of any alternative solutions or features you've considered that could solve your problem.

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other information or screenshots to help describe the feature request here.
validations:
required: false

2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
blank_issues_enabled: false

0 comments on commit 22c63bc

Please sign in to comment.