From eaaff414c951d6d9e34d33ac7ff3d17f384e84df Mon Sep 17 00:00:00 2001 From: Ayodeji Ogundare <63319309+ayodejidev@users.noreply.github.com> Date: Fri, 21 Feb 2025 17:34:34 +0100 Subject: [PATCH] Add GitHub issue forms --- .github/ISSUE_TEMPLATE/bug_report.md | 27 ------- .github/ISSUE_TEMPLATE/bug_report.yml | 93 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.md | 23 ------ .github/ISSUE_TEMPLATE/feature_request.yml | 47 +++++++++++ 5 files changed, 141 insertions(+), 50 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index bb9396f2..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**How to reproduce** -Steps to reproduce the behavior. - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - ruby Version: [x.y.z] - - Library Version: [x.y.z] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..6cb7d1a1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,93 @@ +name: Bug report +description: Report a bug or issue. See closed issues before reporting to confirm issue has not been reported or resolved. +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: "```ruby\n// Your code here\n```" + + - type: input + id: adyen-api-version + attributes: + label: "Adyen Ruby API Library version" + description: "Specify the version of the Adyen API library you're using." + placeholder: "Example: 13.4.0" + validations: + required: true + + - type: input + id: ruby-version + attributes: + label: "Ruby language version" + description: "Specify the Ruby version you're using." + placeholder: "Example: Ruby 3.42" + validations: + required: true + + - 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." \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..ec4bb386 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 96cc02d8..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**ruby version**: x.y.z -**Library version**: x.y.z - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..86076349 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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." \ No newline at end of file