From da4d35e0d36c98c1567fc9ec98753e76c4311410 Mon Sep 17 00:00:00 2001 From: Priyankar Pal <88102392+priyankarpal@users.noreply.github.com> Date: Wed, 26 Jul 2023 12:53:39 +0530 Subject: [PATCH] feat: add new issue templates #88 (#124) --- .github/ISSUE_TEMPLATE/bug.yml | 55 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 26 ----------- .github/ISSUE_TEMPLATE/docs.yml | 28 ++++++++++++ .github/ISSUE_TEMPLATE/feature.yml | 48 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 --------- 5 files changed, 131 insertions(+), 46 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/docs.yml create mode 100644 .github/ISSUE_TEMPLATE/feature.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 00000000..2a237414 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,55 @@ +name: 🐞 Bug Report +description: File a bug report +title: '[Bug]: ' +labels: ['bug'] +body: + - type: textarea + id: what-happened + attributes: + label: What happened? + placeholder: Add clear descriptions about the bug + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Add screenshots + placeholder: Add screenshots + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce the behavior + placeholder: how to reproduce? + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + placeholder: A clear and concise description of what you expected to happen. + validations: + required: true + - type: dropdown + id: Desktop + attributes: + label: What OS are you seeing the problem on? + multiple: true + options: + - Windows + - MacOS + - Linux + - Other + - type: textarea + id: additional-info + attributes: + label: Additional context + placeholder: [e.g. Version - 0.0.24 , Driver - AWS/GCP/Azure/Kubernetes] + - type: checkboxes + id: terms + attributes: + label: 'Record' + options: + - label: I agree to follow this project's Code of Conduct + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index fcc3a97d..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[BUG] - " -labels: bug -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Run command '...' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - -**Additional context** - - Version: 0.0.24 - - Driver: AWS/GCP/Azure/Kubernetes diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml new file mode 100644 index 00000000..d83e157f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs.yml @@ -0,0 +1,28 @@ +name: 🔖 Documentation update +description: Improve Documentation +title: '[Docs]:' +labels: ['documentation'] +body: + - type: textarea + id: improve-docs + attributes: + label: what's wrong with the documentation? + description: which things do we need to add? + placeholder: Add description + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Add screenshots + description: Add screenshots to see the demo + placeholder: Add screenshots + validations: + required: true + - type: checkboxes + id: terms + attributes: + label: 'Record' + options: + - label: I agree to follow this project's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 00000000..760cb9a9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,48 @@ +name: ✨ Feature Request +description: Suggest a new feature request +title: '[Feat]:' +labels: ['enhancement'] +body: + - type: textarea + id: what-feature + attributes: + label: What feature? + placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: true + - type: textarea + id: the-solution + attributes: + label: Describe the solution you'd like + placeholder: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered + placeholder: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional context + placeholder: Add any other context or screenshots about the feature request here. + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Add screenshots + placeholder: Add screenshots + validations: + required: true + - type: checkboxes + id: terms + attributes: + label: 'Record' + options: + - label: I agree to follow this project's Code of Conduct + required: true + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 11fc491e..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: '' - ---- - -**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.