From 0457d03f31bdd8b00cf1a98499e9fd8c41e7bdef Mon Sep 17 00:00:00 2001 From: Sumith prabhu <91826109+sumithprabhu@users.noreply.github.com> Date: Mon, 16 Oct 2023 17:33:06 +0530 Subject: [PATCH] Added a ISSUE template (#787) * Testing * Ducumentation readme issue added * Improvement proposal issue added * other issue added * QS issue added * Content changed * content changes * Content changes * Content Changed --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 79 +++++++++++++++++++ .../DOCUMENTATION_README_ISSUE.yml | 35 ++++++++ .../ISSUE_TEMPLATE/IMPROVEMENT_PROPOSAL.yml | 40 ++++++++++ .github/ISSUE_TEMPLATE/OTHER.yml | 27 +++++++ .github/ISSUE_TEMPLATE/QUESTION_SUPPORT.yml | 15 ++++ 5 files changed, 196 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.yml create mode 100644 .github/ISSUE_TEMPLATE/DOCUMENTATION_README_ISSUE.yml create mode 100644 .github/ISSUE_TEMPLATE/IMPROVEMENT_PROPOSAL.yml create mode 100644 .github/ISSUE_TEMPLATE/OTHER.yml create mode 100644 .github/ISSUE_TEMPLATE/QUESTION_SUPPORT.yml diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml new file mode 100644 index 000000000..5dc22b08f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -0,0 +1,79 @@ +name: "🐛 Bug Report" +description: Create a bug report to help us improve. +title: "🐛 [BUG] - " +labels: [ + "bug" +] +body: + - type: textarea + id: expected-behaviour + attributes: + label: "Expected Behaviour" + description: Please describe the behavior you are expecting + placeholder: Short and explicit description of your desired behaviour... + validations: + required: true + - type: textarea + id: current-behaviour + attributes: + label: "Current Behaviour" + description: Please describe the current behavior + placeholder: What is the current behavior?... + validations: + required: true + - type: textarea + id: reprod + attributes: + label: "Reproduction steps" + description: Please enter an explicit description of your issue + value: | + 1. Go to '...' + 2. Invoke function '...' + 3. See error + render: bash + validations: + required: true + - type: textarea + id: screenshot + attributes: + label: "Screenshots" + description: If applicable, add screenshots to help explain your problem. + value: | + ![DESCRIPTION](LINK.png) + render: bash + validations: + required: false + - type: textarea + id: logs + attributes: + label: "Relevant Logs" + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: bash + validations: + required: false + - type: dropdown + id: dapp-env + attributes: + label: "Dapp Env" + description: What is the impacted DApp environment ? + multiple: true + options: + - Prod (app.push.org) + - Staging (staging.push.org) + - Dev (dev.push.org) + validations: + required: true + - type: dropdown + id: browsers + attributes: + label: "Browsers" + description: What browsers are you seeing the problem on ? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + - Opera + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/DOCUMENTATION_README_ISSUE.yml b/.github/ISSUE_TEMPLATE/DOCUMENTATION_README_ISSUE.yml new file mode 100644 index 000000000..36ad7abc6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/DOCUMENTATION_README_ISSUE.yml @@ -0,0 +1,35 @@ +name: "✏️ Documentation/Readme Enhancement" +description: Suggest an enhancement in documentation/readme. +title: "✏️ [Documentation/Readme Enhancement] - <title>" +labels: [ + "documentation" +] +body: + - type: textarea + id: expected-behaviour + attributes: + label: "Expected Behaviour" + description: Please describe the behavior you are expecting + placeholder: Short and explicit description of your desired behaviour... + validations: + required: false + - type: textarea + id: current-behaviour + attributes: + label: "Current Behaviour" + description: Please describe the current behavior + placeholder: What is the current behavior?... + validations: + required: false + - type: textarea + id: reprod + attributes: + label: "Steps to Reproduce" + description: Please enter an explicit description of your issue + value: | + 1. Go to '...' + 2. Invoke function '...' + 3. See error + render: bash + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/IMPROVEMENT_PROPOSAL.yml b/.github/ISSUE_TEMPLATE/IMPROVEMENT_PROPOSAL.yml new file mode 100644 index 000000000..3f062784e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/IMPROVEMENT_PROPOSAL.yml @@ -0,0 +1,40 @@ +name: "😈 Improvement Proposal" +description: Suggest improvement,whether new or built upon existing features. +title: "😈 [Improvement Proposal] - <title>" +labels: [ + "Improvement proposal" +] +body: + - type: input + id: proposal-name + attributes: + label: "Proposal name" + description: Brief title or summary of the proposed improvement. + placeholder: Summary of the proposal improvement. + validations: + required: true + - type: textarea + id: description + attributes: + label: "Describe the Proposal" + description: Please describe detailed description of the improvement, including the problem it solves and the benefits it brings. + placeholder: Detailed description of your desired proposal... + validations: + required: true + - type: textarea + id: usecase + attributes: + label: "Use Case" + description: Please explain the specific use cases or scenarios where this improvement would be valuable.. + placeholder: List down the use case. + validations: + required: true + - type: textarea + id: current-limitations + attributes: + label: "Current Limitations" + description: Any existing limitations, issues, or challenges with the SDK that the proposed improvement aims to address. + placeholder: Overview for the current problem/limitations. + validations: + required: true + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/OTHER.yml b/.github/ISSUE_TEMPLATE/OTHER.yml new file mode 100644 index 000000000..21941d88a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/OTHER.yml @@ -0,0 +1,27 @@ +name: "👾 Other" +description: Something that doesn't belong elsewhere. +title: "👾 [Other] - <title>" +labels: [ + "Other" +] +body: + - type: textarea + id: description + attributes: + label: "Description" + description: Please describe something + placeholder: Detailed description of what you wanna share... + validations: + required: true + - type: dropdown + id: dapp-env + attributes: + label: "Dapp Env" + description: What is the impacted DApp environment ? + multiple: true + options: + - Prod (app.push.org) + - Staging (staging.push.org) + - Dev (dev.push.org) + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/QUESTION_SUPPORT.yml b/.github/ISSUE_TEMPLATE/QUESTION_SUPPORT.yml new file mode 100644 index 000000000..2085f49e5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/QUESTION_SUPPORT.yml @@ -0,0 +1,15 @@ +name: "❓ Question or Support Request" +description: Questions and requests for support. +title: "❓ [Question/Support] - <title>" +labels: [ + "support" +] +body: + - type: textarea + id: support-request + attributes: + label: "Question or Support Request" + description: Describe your question or ask for support. + placeholder: Detailed description of your question/support request... + validations: + required: true \ No newline at end of file