Skip to content

Commit

Permalink
Merge pull request #1470 from Adyen/improve-issue-templates
Browse files Browse the repository at this point in the history
Improve issue templates
  • Loading branch information
ayodejidev authored Feb 20, 2025
2 parents 2053aa8 + 6a518b6 commit eeea7fc
Show file tree
Hide file tree
Showing 4 changed files with 147 additions and 48 deletions.
28 changes: 0 additions & 28 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

100 changes: 100 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
name: Bug Report
description: Report a bug or issue. See closed issues before reporting the bug.
title: "[Bug]: "
labels: ["bug"]
assignees: []
body:
- type: markdown
attributes:
value: "#### Thank you for reporting this issue. Please provide all the required information to help us understand and resolve the issue."

- type: input
id: bug-description
attributes:
label: "Description"
description: "Provide a summary of the issue."
placeholder: "Example: Adyen Checkout API returns an unexpected error when..."
validations:
required: true

- type: textarea
id: reproduce-steps
attributes:
label: "Steps to reproduce"
description: "List necessary steps to help us reproduce the issue."
placeholder: |
1. Install the Adyen API'...'
2. Create '...'
3. Import and use the NotificationRequest object '...'
3. Run '...'
4. Observer error '...'
validations:
required: true

- type: textarea
id: actual-behavior
attributes:
label: "Actual behavior"
description: "Describe what happened - the error or unexpected behaviour you see."
placeholder: "Example: The API returns a 500 internal server error."

- type: textarea
id: expected-behavior
attributes:
label: "Expected behavior"
description: "Describe what you expected to happen."
placeholder: "Example: The Adyen Checkout API should return a 200 status with the correct response payload."
validations:
required: true

- type: textarea
id: code-snippet
attributes:
label: "Code snippet or screenshots (if applicable)"
description: "Provide relevant code snippets or screenshots to illustrate the issue."
placeholder: "```js\n// Your code here\n```"

- type: input
id: adyen-api-version
attributes:
label: "Adyen Node API Library version"
description: "Specify the version of the Adyen API library you're using."
placeholder: "Example: 20.1.2"
validations:
required: true

- type: input
id: node-version
attributes:
label: "Node.js version"
description: "Specify the Node.js version you're using."
placeholder: "Example: 16.14.0"
validations:
required: true

- type: input
id: npm-version
attributes:
label: "NPM version"
description: "Specify the NPM version you're using (optional)."
placeholder: "Example: 8.5.0"

- type: dropdown
id: operating-system
attributes:
label: "Operating System"
description: "Select your operating system."
options:
- Windows
- macOS
- Linux
- Other
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: "Additional context"
description: "Provide any other relevant details."
placeholder: "Example: This issue started after updating to version X."
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Feature Request
description: Request a new feature or improvement. See open issues before requesting.
title: "[Feature]: "
labels: ["Feature"]
assignees: []
body:
- type: markdown
attributes:
value: "#### Is your feature request related to a problem? Please describe."

- type: input
id: feature-summary
attributes:
label: "Feature summary"
description: "Provide a short description of the feature request."
placeholder: "Example: Add support for donation event."

- type: textarea
id: problem-statement
attributes:
label: "Problem statement"
description: "Explain the problem this feature aims to solve."
placeholder: "Example: I have an issue with consuming the donations webhook."
validations:
required: true

- type: textarea
id: proposed-solution
attributes:
label: "Proposed solution"
description: "Describe how you want this feature to work."
placeholder: "Example: Add Donation enum to ..."
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: "Alternatives considered"
description: "Describe any alternative solutions you've explored."
placeholder: "Example: I tried to extend the current namespace but ..."

- type: textarea
id: additional-context
attributes:
label: "Additional context"
description: "Provide any extra details, references, or screenshots."

0 comments on commit eeea7fc

Please sign in to comment.