-
Notifications
You must be signed in to change notification settings - Fork 79
Improve issue templates #1470
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Improve issue templates #1470
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
ec0cde8
Add bug report form
ayodejidev 469a788
Add feature request form
ayodejidev 66437a3
Remove previous .md issue templates
ayodejidev ea88237
Remove sonar file in favour of Automatic Analysis
ayodejidev 09419d1
Revert "Remove sonar file in favour of Automatic Analysis"
ayodejidev 96c8312
Merge branch 'main' into improve-issue-templates
ayodejidev 1bd2682
Update bug_report.yml
ayodejidev 6a518b6
Improve issue description.
ayodejidev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
ayodejidev marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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 | ||
ayodejidev marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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 | ||
Kwok-he-Chu marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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." |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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." |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.