Skip to content

Commit eeff442

Browse files
MatKuhrMatKuhr
authored
chore: [DevOps] Add Pretty Issue Templates (#651)
1 parent 90cfec6 commit eeff442

File tree

4 files changed

+182
-90
lines changed

4 files changed

+182
-90
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
name: Bug Report
2+
description: Released feature does not work as expected in the SAP Cloud SDK for Java.
3+
labels:
4+
- bug
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
This repository is for Java related issues only. Please open [JavaScript / TypeScript issues here](https://github.com/SAP/cloud-sdk-js/issues/new/choose)
10+
- type: textarea
11+
attributes:
12+
label: "Describe the Bug"
13+
description: "A clear and concise description of what the bug is."
14+
validations:
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: "Steps to Reproduce"
19+
description: "Steps to reproduce the behavior."
20+
placeholder: |
21+
1. Set up ...
22+
2. Execute ...
23+
3. Confirm ...
24+
4. See error
25+
validations:
26+
required: true
27+
- type: textarea
28+
attributes:
29+
label: "Expected Behavior"
30+
description: "A clear and concise description of what you expected to happen. In case of HTTP requests, a working Postman (or similar) request is very helpful."
31+
validations:
32+
required: true
33+
- type: textarea
34+
attributes:
35+
label: "Screenshots"
36+
description: "Add screenshots to help explain your problem."
37+
validations:
38+
required: false
39+
- type: textarea
40+
attributes:
41+
label: "Used Versions"
42+
description: "Provide versions used in the project."
43+
value: |
44+
- Java and Maven version via `mvn --version`: ...
45+
- SAP Cloud SDK version: ...
46+
- Spring Boot or CAP version: ...
47+
- <details><summary>Dependency tree via `mvn dependency:tree`</summary>
48+
49+
```
50+
Dependency tree here
51+
```
52+
</details>
53+
validations:
54+
required: true
55+
- type: textarea
56+
attributes:
57+
label: "Code Examples"
58+
description: "Add code snippets as examples to help explain your problem. Please remove sensitive information."
59+
value: |
60+
```java
61+
// Your code here
62+
```
63+
validations:
64+
required: false
65+
- type: textarea
66+
attributes:
67+
label: "Stack Trace"
68+
description: "Add your stack trace here. Please remove sensitive information."
69+
validations:
70+
required: false
71+
- type: textarea
72+
attributes:
73+
label: "Log File"
74+
description: "Add your log file or related error message. Please remove sensitive information."
75+
value: |
76+
<details><summary>Log file</summary>
77+
...
78+
</details>
79+
validations:
80+
required: false
81+
- type: dropdown
82+
attributes:
83+
label: "Affected Development Phase"
84+
description: "Choose the development phase affected by this issue."
85+
multiple: false
86+
options:
87+
- Getting Started
88+
- Development
89+
- Release
90+
- Production
91+
validations:
92+
required: true
93+
- type: dropdown
94+
attributes:
95+
label: "Impact"
96+
description: "Choose the impact severity."
97+
multiple: false
98+
options:
99+
- No Impact
100+
- Inconvenience
101+
- Impaired
102+
- Blocked
103+
validations:
104+
required: true
105+
- type: textarea
106+
attributes:
107+
label: "Timeline"
108+
description: "Please briefly state your timeline, e.g., Go-Live in 12 weeks."
109+
validations:
110+
required: false

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

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

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Question
2+
description: Ask a question about the SAP Cloud SDK for Java.
3+
labels:
4+
- question
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
This repository is for Java related issues only. Please open [JavaScript / TypeScript issues here](https://github.com/SAP/cloud-sdk-js/issues/new/choose)
10+
- type: textarea
11+
attributes:
12+
label: "Ask the Question"
13+
description: Give a clear and concise description.
14+
validations:
15+
required: true

‎.github/ISSUE_TEMPLATE/sdk-issue.md‎

Lines changed: 0 additions & 90 deletions
This file was deleted.

0 commit comments

Comments
 (0)