Skip to content

Commit 4fa8fd3

Browse files
chore: update issue templates (#5273) (#5309)
Co-authored-by: Zhongpin Wang <[email protected]>
1 parent b6ebdc5 commit 4fa8fd3

File tree

6 files changed

+197
-95
lines changed

6 files changed

+197
-95
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 53 deletions
This file was deleted.
Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
name: Bug Report
2+
description: Released feature does not work as expected in the SAP Cloud SDK (JavaScript / TypeScript).
3+
title: '<title>'
4+
labels:
5+
- bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
> [!note]
11+
> Please note that this repository is for JavaScript / TypeScript related issues only.
12+
> If you have a question about the SAP Cloud SDK (Java), open a GitHub issue here: https://github.com/SAP/cloud-sdk-java/issues/new/choose
13+
- type: markdown
14+
attributes:
15+
value: |
16+
> [!important]
17+
> Please read the [Troubleshooting](https://sap.github.io/cloud-sdk/docs/js/troubleshooting) documentation first.
18+
> Always provide detailed information such as logs, callstack and error messages to help us understand the issue.
19+
> Explain why you think this is a bug in the SAP Cloud SDK.
20+
- type: textarea
21+
attributes:
22+
label: "Describe the Bug"
23+
description: "A clear and concise description of what the bug is."
24+
validations:
25+
required: true
26+
- type: textarea
27+
attributes:
28+
label: "Steps to Reproduce"
29+
description: "Steps to reproduce the behavior."
30+
placeholder: |
31+
1. Set up ...
32+
2. Execute ...
33+
3. Confirm ...
34+
4. See error
35+
validations:
36+
required: true
37+
- type: textarea
38+
attributes:
39+
label: "Expected Behavior"
40+
description: "A clear and concise description of what you expected to happen."
41+
validations:
42+
required: true
43+
- type: textarea
44+
attributes:
45+
label: "Screenshots"
46+
description: "Add screenshots to help explain your problem."
47+
validations:
48+
required: false
49+
- type: textarea
50+
attributes:
51+
label: "Used Versions"
52+
description: "Provide versions used in the project."
53+
value: |
54+
- Node version via `node -v`: ...
55+
- NPM version via `npm -v: ...
56+
- SAP Cloud SDK version: ...
57+
- For CAP users, CAP version: ...
58+
validations:
59+
required: true
60+
- type: textarea
61+
attributes:
62+
label: "Code Examples"
63+
description: "Add code snippets as examples to help explain your problem. Please remove sensitive information."
64+
validations:
65+
required: false
66+
- type: textarea
67+
attributes:
68+
label: "Log File"
69+
description: "Add your log file or related error message. Again, please remove sensitive information."
70+
validations:
71+
required: false
72+
- type: dropdown
73+
attributes:
74+
label: "Affected Development Phase"
75+
description: "Choose the development phase affected by this issue."
76+
multiple: false
77+
options:
78+
- Getting Started
79+
- Development
80+
- Release
81+
- Production
82+
validations:
83+
required: true
84+
- type: dropdown
85+
attributes:
86+
label: "Impact"
87+
description: "Choose the impact severity."
88+
multiple: false
89+
options:
90+
- No Impact
91+
- Inconvenience
92+
- Impaired
93+
- Blocked
94+
validations:
95+
required: true
96+
- type: textarea
97+
attributes:
98+
label: "Timeline"
99+
description: "Please briefly state your timeline, e.g., Go-Live in 12 weeks."
100+
validations:
101+
required: false
102+
- type: textarea
103+
attributes:
104+
label: "Additional Context"
105+
description: "Add any other context about the problem here."
106+
validations:
107+
required: false

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 33 deletions
This file was deleted.
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: Feature Request
2+
description: Request a new feature to help your project using the SAP Cloud SDK (JavaScript / TypeScript).
3+
title: '<title>'
4+
labels:
5+
- feature request
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
> [!note]
11+
> Please note that this repository is for JavaScript / TypeScript related issues only.
12+
> If you have a question about the SAP Cloud SDK (Java), open a GitHub issue here: https://github.com/SAP/cloud-sdk-java/issues/new/choose
13+
- type: textarea
14+
attributes:
15+
label: "Describe the Problem"
16+
description: A clear and concise description of what the problem is, e.g., I'm always frustrated when [...]
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: "Propose a Solution"
22+
description: A clear and concise description of what you want to happen.
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: "Describe Alternatives"
28+
description: A clear and concise description of any alternative solutions or features you've considered.
29+
validations:
30+
required: false
31+
- type: dropdown
32+
attributes:
33+
label: "Affected Development Phase"
34+
description: "Choose the development phase affected by this issue."
35+
multiple: false
36+
options:
37+
- Getting Started
38+
- Development
39+
- Release
40+
- Production
41+
validations:
42+
required: true
43+
- type: dropdown
44+
attributes:
45+
label: "Impact"
46+
description: "Choose the impact severity."
47+
multiple: false
48+
options:
49+
- No Impact
50+
- Inconvenience
51+
- Impaired
52+
- Blocked
53+
validations:
54+
required: true
55+
- type: textarea
56+
attributes:
57+
label: "Timeline"
58+
description: "Please briefly state your timeline, e.g., Go-Live in 12 weeks."
59+
validations:
60+
required: false
61+
- type: textarea
62+
attributes:
63+
label: "Additional Context"
64+
description: "Add any other context about the feature request here."
65+
validations:
66+
required: false

.github/ISSUE_TEMPLATE/question.md

Lines changed: 0 additions & 9 deletions
This file was deleted.
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Question
2+
description: Ask a question about the SAP Cloud SDK (JavaScript / TypeScript).
3+
title: '<title>'
4+
labels:
5+
- question
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
> [!note]
11+
> Please note that this repository is for JavaScript / TypeScript related issues only.
12+
> If you have a question about the SAP Cloud SDK (Java), open a GitHub issue here: https://github.com/SAP/cloud-sdk-java/issues/new/choose
13+
- type: markdown
14+
attributes:
15+
value: |
16+
> [!important]
17+
> Please read the [Troubleshooting](https://sap.github.io/cloud-sdk/docs/js/troubleshooting) documentation first.
18+
> Always provide detailed information such as logs, callstack and error messages to help us understand the question.
19+
- type: textarea
20+
attributes:
21+
label: "Describe the Question"
22+
description: A clear and concise description of your question.
23+
validations:
24+
required: true

0 commit comments

Comments
 (0)