Skip to content

Commit b693557

Browse files
ayodejidevcandemiralpkhushboo-singhvi
authored
Improve GitHub issue template (#2930)
* Add bug report form * Add feature request form * Improve issue config * Remove old templates in favour of new issue forms * Update label to match previous template * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Can Demiralp <ecandemiralp@gmail.com> * Update feature_request.yml --------- Co-authored-by: Can Demiralp <ecandemiralp@gmail.com> Co-authored-by: Khushboo <khushboo.singhvi@adyen.com>
1 parent 1d89318 commit b693557

File tree

5 files changed

+167
-70
lines changed

5 files changed

+167
-70
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 46 deletions
This file was deleted.
Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
name: Bug report
2+
description: Create a report to help us improve. See closed issues before reporting to confirm the issue has not been reported or resolved.
3+
title: "[Bug]: "
4+
labels: ["Bug report"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
#### Thank you for reporting this issue. Please provide all the required information to help us understand and resolve the issue.
10+
Making your own contribution is easy, encouraged, and greatly appreciated! For more info, please refer to the [contribution guidelines](https://github.com/Adyen/adyen-magento2/blob/main/CONTRIBUTING.md).
11+
12+
- type: input
13+
id: bug-description
14+
attributes:
15+
label: "Description"
16+
description: "Provide a clear and concise description of the bug."
17+
placeholder: "Example: Ideal Payment Options are not visible on..."
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: reproduce-steps
23+
attributes:
24+
label: "Steps to reproduce"
25+
description: "List necessary steps to help us reproduce the issue."
26+
placeholder: |
27+
1. Install Adyen plugin "v..." in Magento "v..."
28+
2. Add items to the cart
29+
3. Select the payment method "..."
30+
4. Proceed to checkout
31+
5. Check the payment methods
32+
6. Observe error "..."
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: actual-behavior
38+
attributes:
39+
label: "Actual behavior"
40+
description: "Describe what happened - the error or unexpected behavior you see."
41+
placeholder: "Example: Ideal Payment method is not visible..."
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: expected-behavior
47+
attributes:
48+
label: "Expected behavior"
49+
description: "Describe what you expected to happen."
50+
placeholder: "Example: Ideal Payment method should be visible..."
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: code-snippet
56+
attributes:
57+
label: "Code snippet or screenshots (if applicable)"
58+
description: "Provide relevant code snippets or screenshots to illustrate the issue."
59+
placeholder: "```php\n// Your code here\n```"
60+
61+
- type: input
62+
id: adyen-magento-plugin-version
63+
attributes:
64+
label: "Adyen Magento Plugin version"
65+
description: "Specify the version of the Adyen Magento plugin you're using."
66+
placeholder: "Example: 9.0.0"
67+
validations:
68+
required: true
69+
70+
- type: input
71+
id: magento-version
72+
attributes:
73+
label: "Magento version"
74+
description: "Specify the version of Magento you're using."
75+
placeholder: "Example: 2.4.7-p1"
76+
validations:
77+
required: true
78+
79+
- type: dropdown
80+
id: operating-system
81+
attributes:
82+
label: "Operating System"
83+
description: "Select your operating system."
84+
options:
85+
- Windows
86+
- macOS
87+
- Linux
88+
- Other
89+
validations:
90+
required: false
91+
92+
- type: input
93+
id: browser
94+
attributes:
95+
label: "Browser (if applicable)"
96+
description: "Specify the browser and version you're using."
97+
placeholder: "Example: Chrome 112.0.5615.49"
98+
validations:
99+
required: false
100+
101+
- type: textarea
102+
id: additional-context-and-logs
103+
attributes:
104+
label: "Additional context and logs"
105+
description: "Provide any other relevant details or paste relevant logs."
106+
placeholder: |
107+
Example: This issue started after updating to version X.
108+
Logs:
109+
```
110+
[2025-04-02 10:00:00] main.ERROR: Exception message...
111+
```

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
blank_issues_enabled: false
1+
# This configuration file manages issue template settings for the repository.
2+
3+
blank_issues_enabled: false # Disables blank issues to encourage use of templates.
4+
25
contact_links:
36
- name: Adyen Support
47
url: https://support.adyen.com/hc/en-us/requests/new?ticket_form_id=360000705420
5-
about: For other questions, contact our support team
8+
about: For other questions, contact our support team.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 22 deletions
This file was deleted.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Feature request
2+
description: Suggest an idea for this project. See open issues before requesting.
3+
title: "[Feature]: "
4+
labels: ["Enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
#### Thank you for suggesting a feature! Please provide all the required information to help us evaluate your request.
10+
Making your own contribution is easy, encouraged, and greatly appreciated! For more info, please refer to the [contribution guidelines](https://github.com/Adyen/adyen-magento2/blob/main/CONTRIBUTING.md).
11+
12+
- type: input
13+
id: feature-summary
14+
attributes:
15+
label: "Feature summary"
16+
description: "Provide a short description of the feature request."
17+
placeholder: "Example: Add support for donation."
18+
19+
- type: textarea
20+
id: problem-statement
21+
attributes:
22+
label: "Is your feature request related to a problem? Please describe."
23+
description: "Explain the problem this feature aims to solve."
24+
placeholder: "Example: I'm always frustrated when..."
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: proposed-solution
30+
attributes:
31+
label: "Describe the solution you'd like"
32+
description: "Provide a clear and concise description of what you want to happen."
33+
placeholder: "Example: Add Donation feature to..."
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: alternatives
39+
attributes:
40+
label: "Describe alternatives you've considered"
41+
description: "Provide a clear and concise description of any alternative solutions or features you've considered."
42+
placeholder: "Example: I tried to... but..."
43+
validations:
44+
required: false
45+
46+
- type: textarea
47+
id: additional-context
48+
attributes:
49+
label: "Additional context"
50+
description: "Add any other context, references, or screenshots about the feature request."
51+
placeholder: "Example: This feature would help users by..."

0 commit comments

Comments
 (0)