From a2444b138cf448b8008f7868f57cf6a8b48c9778 Mon Sep 17 00:00:00 2001 From: Abhishek Hegde Date: Sat, 5 Oct 2024 11:32:43 +0530 Subject: [PATCH 1/2] chore: Update issue and feature request templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 58 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 51 +++++++++++++++++++ 2 files changed, 109 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..3a24202 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,58 @@ +name: 🐛 Bug +description: Report an issue to help improve the project. +title: "[BUG] " +labels: ["bug", "status: awaiting triage"] +body: + - type: checkboxes + id: duplicates + attributes: + label: Has this bug been raised before? + description: Increase the chances of your issue being accepted by making sure it has not been raised before. + options: + - label: I have checked "open" AND "closed" issues and this is not a duplicate + required: true + - type: textarea + id: description + attributes: + label: Description + description: A clear description of the bug you have found. Please include relevant information and resources (for example the steps to reproduce the bug) + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + description: To help us recreate the bug, provide a numbered list of the exact steps taken to trigger the buggy behavior. + value: | + Include any relevant details like: + + - What page you were on... + - What you were trying to do... + - What went wrong... + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: Please add screenshots if applicable + validations: + required: false + - type: dropdown + id: assignee + attributes: + label: Do you want to work on this issue? + multiple: false + options: + - "No" + - "Yes" + default: 0 + validations: + required: false + - type: textarea + id: extrainfo + attributes: + label: If "yes" to above, please explain how you would technically implement this + description: For example reference any existing code + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..bd2df25 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,51 @@ +name: 💡 General Feature Request +description: Have a new idea/feature? Let us know... +title: "[FEATURE] " +labels: ["enhancement", "feature", "status: awaiting triage"] +body: + - type: checkboxes + id: duplicates + attributes: + label: Is this a unique feature? + description: Increase the chances of your issue being accepted by making sure it has not been raised before. + options: + - label: I have checked "open" AND "closed" issues and this is not a duplicate + required: true + - type: textarea + attributes: + label: Is your feature request related to a problem/unavailable functionality? Please describe. + description: A clear and concise description of what the problem is (for example "I'm always frustrated when [...]"). + validations: + required: true + - type: textarea + id: description + attributes: + label: Proposed Solution + description: A clear description of the enhancement you propose. Please include relevant information and resources (for example another project's implementation of this feature). + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: Please add screenshots of the before and/or after the proposed changes. + validations: + required: false + - type: dropdown + id: assignee + attributes: + label: Do you want to work on this issue? + multiple: false + options: + - "No" + - "Yes" + default: 0 + validations: + required: false + - type: textarea + id: extrainfo + attributes: + label: If "yes" to above, please explain how you would technically implement this (issue will not be assigned if this is skipped) + description: For example reference any existing code or library + validations: + required: false \ No newline at end of file From 4cd547e9c499c3f1928c8ccba88b816fe2ace8ab Mon Sep 17 00:00:00 2001 From: Abhishek Hegde Date: Sat, 5 Oct 2024 11:38:35 +0530 Subject: [PATCH 2/2] commit [Feat] - Add Issue Templates #36 --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 3a24202..0f7afe6 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -52,7 +52,7 @@ body: - type: textarea id: extrainfo attributes: - label: If "yes" to above, please explain how you would technically implement this + label: If "yes" to the above, please explain how you would technically implement this. description: For example reference any existing code validations: required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index bd2df25..99feac7 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -28,7 +28,7 @@ body: id: screenshots attributes: label: Screenshots - description: Please add screenshots of the before and/or after the proposed changes. + description: Please include screenshots showing the state of the application before and after the proposed changes. validations: required: false - type: dropdown