Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 133 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
name: Bug Report
description: Released feature does not work as expected in the SAP Cloud SDK for AI (Python).
title: '<title>'
labels:
- bug
body:
- type: markdown
attributes:
value: |
Please note that this repository is for Python and SDK related issues only.
Issue for SAP Cloud SDK for AI (JS/TS), please open [here](https://github.com/SAP/ai-sdk-js/issues/new/choose).
Issue for SAP Cloud SDK for AI (Java), please open [here](https://github.com/SAP/ai-sdk-java/issues/new/choose).
Issue for SAP AI Core services (Orchestration, Grounding, Prompt Registry, ...), please refer to the [SAP AI Core Support Process](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/support-process).
- type: checkboxes
attributes:
label: "Checklist"
description: "Before submitting your issue, please make sure to check the following:"
options:
- label: "My issue is not an [AI Core service issue](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/support-process), but an SDK issue."
required: true
- label: "My issue is a Python related issue, not a [JS/TS](https://github.com/SAP/ai-sdk-js/issues) or [Java](https://github.com/SAP/ai-sdk-java/issues) related issue."
required: true
- label: "My issue is not [already reported or documented](https://github.com/SAP/ai-sdk-python/issues)."
required: true
- type: textarea
attributes:
label: "Describe the Bug"
description: "A clear and concise description of what the bug is."
validations:
required: true
- type: textarea
attributes:
label: "Steps to Reproduce"
description: "Steps to reproduce the behavior."
placeholder: |
1. Set up ...
2. Execute ...
3. Confirm ...
4. See error
validations:
required: true
- type: textarea
attributes:
label: "Expected Behavior"
description: "A clear and concise description of what you expected to happen."
validations:
required: true
- type: textarea
attributes:
label: "Screenshots"
description: "Add screenshots to help explain your problem."
validations:
required: false
- type: textarea
attributes:
label: "Used Versions"
description: "Provide versions used in the project."
value: |
- Python version via `python3 --version`: ...
- SAP Cloud SDK for AI package version:
- ...
- ...
validations:
required: true
- type: textarea
attributes:
label: "Code Examples"
description: "Add code snippets as examples to help explain your problem. Please remove sensitive information."
validations:
required: false
- type: textarea
attributes:
label: "Log File"
description: "Add your log file or related error message. Again, please remove sensitive information."
validations:
required: false
- type: dropdown
attributes:
label: "Region"
description: "Choose the region of your AI Core service."
multiple: true
options:
- AP10
- EU10 Canary
- EU10
- EU11
- EU12 Canary
- EU20
- EU30
- JP10
- US10
- US21
- US30
- SA30
- Not listed above
validations:
required: true
- type: dropdown
attributes:
label: "Affected Development Phase"
description: "Choose the development phase affected by this issue."
multiple: false
options:
- Getting Started
- Development
- Release
- Production
validations:
required: true
- type: dropdown
attributes:
label: "Impact"
description: "Choose the impact severity."
multiple: false
options:
- No Impact
- Inconvenience
- Impaired
- Blocked
validations:
required: true
- type: textarea
attributes:
label: "Timeline"
description: "Please briefly state your timeline, e.g., Go-Live in 12 weeks."
validations:
required: false
- type: textarea
attributes:
label: "Additional Context"
description: "Add any other context about the problem here."
validations:
required: false
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: SAP Cloud SDK for AI (JS/TS) Issues
url: https://github.com/SAP/ai-sdk-js/issues/new/choose
about: Please report issues concerning the SAP Cloud SDK for AI (JS/TS) here.
- name: SAP Cloud SDK for AI (Java) Issues
url: https://github.com/SAP/ai-sdk-java/issues/new/choose
about: Please report issues concerning the SAP Cloud SDK for AI (Java) here.
- name: SAP AI Core Service Issues
url: https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/support-process
about: Please refer to the SAP AI Core Support Process for issues concerning SAP AI Core services (Orchestration, Grounding, Prompt Registry, ...).
78 changes: 78 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: Feature Request
description: Request a new feature to help your project using the SAP Cloud SDK for AI (Python).
title: '<title>'
labels:
- feature request
body:
- type: markdown
attributes:
value: |
Please note that this repository is for Python and SDK related issues only.
Issue for SAP Cloud SDK for AI (JS/TS), please open [here](https://github.com/SAP/ai-sdk-js/issues/new/choose).
Issue for SAP Cloud SDK for AI (Java), please open [here](https://github.com/SAP/ai-sdk-java/issues/new/choose).
Issue for SAP AI Core services (Orchestration, Grounding, Prompt Registry, ...), please refer to the [SAP AI Core Support Process](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/support-process).
- type: checkboxes
attributes:
label: "Checklist"
description: "Before submitting your issue, please make sure to check the following:"
options:
- label: "My issue is not an [AI Core service issue](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/support-process), but an SDK issue."
required: true
- label: "My issue is a Python related issue, not a [JS/TS](https://github.com/SAP/ai-sdk-js/issues) or [Java](https://github.com/SAP/ai-sdk-java/issues) related issue."
required: true
- label: "My issue is not [already reported or documented](https://github.com/SAP/ai-sdk-python/issues)."
required: true
- type: textarea
attributes:
label: "Describe the Problem"
description: A clear and concise description of what the problem is, e.g., I'm always frustrated when [...]
validations:
required: true
- type: textarea
attributes:
label: "Propose a Solution"
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
attributes:
label: "Describe Alternatives"
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false
- type: dropdown
attributes:
label: "Affected Development Phase"
description: "Choose the development phase affected by this issue."
multiple: false
options:
- Getting Started
- Development
- Release
- Production
validations:
required: true
- type: dropdown
attributes:
label: "Impact"
description: "Choose the impact severity."
multiple: false
options:
- No Impact
- Inconvenience
- Impaired
- Blocked
validations:
required: true
- type: textarea
attributes:
label: "Timeline"
description: "Please briefly state your timeline, e.g., Go-Live in 12 weeks."
validations:
required: false
- type: textarea
attributes:
label: "Additional Context"
description: "Add any other context about the feature request here."
validations:
required: false
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Question
description: Ask a question about the SAP Cloud SDK for AI (Python).
title: '<title>'
labels:
- question
body:
- type: markdown
attributes:
value: |
Please note that this repository is for Python and SDK related issues only.
Issue for SAP Cloud SDK for AI (JS/TS), please open [here](https://github.com/SAP/ai-sdk-js/issues/new/choose).
Issue for SAP Cloud SDK for AI (Java), please open [here](https://github.com/SAP/ai-sdk-java/issues/new/choose).
Issue for SAP AI Core services (Orchestration, Grounding, Prompt Registry, ...), please refer to the [SAP AI Core Support Process](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/support-process).
- type: checkboxes
attributes:
label: "Checklist"
description: "Before submitting your issue, please make sure to check the following:"
options:
- label: "My issue is not an [AI Core service issue](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/support-process), but an SDK issue."
required: true
- label: "My issue is a Python related issue, not a [JS/TS](https://github.com/SAP/ai-sdk-js/issues) or [Java](https://github.com/SAP/ai-sdk-java/issues) related issue."
required: true
- label: "My issue is not [already reported or documented](https://github.com/SAP/ai-sdk-js/issues)."
required: true
- type: textarea
attributes:
label: "Describe the Question"
description: A clear and concise description of your question.
validations:
required: true
17 changes: 17 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## Context

Closes SAP/ai-sdk-python-backlog#ISSUENUMBER.

## What this PR does and why it is needed

<!-- Please provide a description summarizing your changes and their rationale -->

<!-- Before raising this PR, please review the Definition of Done below and confirm that all applicable items are completed.
## Definition of Done

- [ ] Code is tested (Unit, Integration, E2E)
- [ ] Error handling created / updated & covered by the tests above
- [ ] Documentation updated
- Only Public APIs are allowed to be used in documentation/tutorials/sample code
- [ ] (Optional) Aligned changes with the JS/TS and Java SDK
- [ ] (Optional) Release notes updated -->