Skip to content

Commit eeea7fc

Browse files
authored
Merge pull request #1470 from Adyen/improve-issue-templates
Improve issue templates
2 parents 2053aa8 + 6a518b6 commit eeea7fc

File tree

4 files changed

+147
-48
lines changed

4 files changed

+147
-48
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

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

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
name: Bug Report
2+
description: Report a bug or issue. See closed issues before reporting the bug.
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: "#### Thank you for reporting this issue. Please provide all the required information to help us understand and resolve the issue."
10+
11+
- type: input
12+
id: bug-description
13+
attributes:
14+
label: "Description"
15+
description: "Provide a summary of the issue."
16+
placeholder: "Example: Adyen Checkout API returns an unexpected error when..."
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduce-steps
22+
attributes:
23+
label: "Steps to reproduce"
24+
description: "List necessary steps to help us reproduce the issue."
25+
placeholder: |
26+
1. Install the Adyen API'...'
27+
2. Create '...'
28+
3. Import and use the NotificationRequest object '...'
29+
3. Run '...'
30+
4. Observer error '...'
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: actual-behavior
36+
attributes:
37+
label: "Actual behavior"
38+
description: "Describe what happened - the error or unexpected behaviour you see."
39+
placeholder: "Example: The API returns a 500 internal server error."
40+
41+
- type: textarea
42+
id: expected-behavior
43+
attributes:
44+
label: "Expected behavior"
45+
description: "Describe what you expected to happen."
46+
placeholder: "Example: The Adyen Checkout API should return a 200 status with the correct response payload."
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: code-snippet
52+
attributes:
53+
label: "Code snippet or screenshots (if applicable)"
54+
description: "Provide relevant code snippets or screenshots to illustrate the issue."
55+
placeholder: "```js\n// Your code here\n```"
56+
57+
- type: input
58+
id: adyen-api-version
59+
attributes:
60+
label: "Adyen Node API Library version"
61+
description: "Specify the version of the Adyen API library you're using."
62+
placeholder: "Example: 20.1.2"
63+
validations:
64+
required: true
65+
66+
- type: input
67+
id: node-version
68+
attributes:
69+
label: "Node.js version"
70+
description: "Specify the Node.js version you're using."
71+
placeholder: "Example: 16.14.0"
72+
validations:
73+
required: true
74+
75+
- type: input
76+
id: npm-version
77+
attributes:
78+
label: "NPM version"
79+
description: "Specify the NPM version you're using (optional)."
80+
placeholder: "Example: 8.5.0"
81+
82+
- type: dropdown
83+
id: operating-system
84+
attributes:
85+
label: "Operating System"
86+
description: "Select your operating system."
87+
options:
88+
- Windows
89+
- macOS
90+
- Linux
91+
- Other
92+
validations:
93+
required: true
94+
95+
- type: textarea
96+
id: additional-context
97+
attributes:
98+
label: "Additional context"
99+
description: "Provide any other relevant details."
100+
placeholder: "Example: This issue started after updating to version X."

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 20 deletions
This file was deleted.
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Feature Request
2+
description: Request a new feature or improvement. See open issues before requesting.
3+
title: "[Feature]: "
4+
labels: ["Feature"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: "#### Is your feature request related to a problem? Please describe."
10+
11+
- type: input
12+
id: feature-summary
13+
attributes:
14+
label: "Feature summary"
15+
description: "Provide a short description of the feature request."
16+
placeholder: "Example: Add support for donation event."
17+
18+
- type: textarea
19+
id: problem-statement
20+
attributes:
21+
label: "Problem statement"
22+
description: "Explain the problem this feature aims to solve."
23+
placeholder: "Example: I have an issue with consuming the donations webhook."
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: proposed-solution
29+
attributes:
30+
label: "Proposed solution"
31+
description: "Describe how you want this feature to work."
32+
placeholder: "Example: Add Donation enum to ..."
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: alternatives
38+
attributes:
39+
label: "Alternatives considered"
40+
description: "Describe any alternative solutions you've explored."
41+
placeholder: "Example: I tried to extend the current namespace but ..."
42+
43+
- type: textarea
44+
id: additional-context
45+
attributes:
46+
label: "Additional context"
47+
description: "Provide any extra details, references, or screenshots."

0 commit comments

Comments
 (0)