From ee806505dde6dd2d57dad3c40fd7a249d4df8e74 Mon Sep 17 00:00:00 2001 From: Tony Stark <73957207+TonyStark-47@users.noreply.github.com> Date: Sun, 12 May 2024 12:00:28 +0530 Subject: [PATCH 1/3] Update and rename bug_report.md to bug_report.yml Made this bug_report issue template visually appealing and added an issue form to make it easier for the contributor to raise it. --- .github/ISSUE_TEMPLATE/bug_report.md | 38 --------------------- .github/ISSUE_TEMPLATE/bug_report.yml | 48 +++++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 38 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index dd84ea7..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +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. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**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):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**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 0000000..421171d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,48 @@ +name: Bug report 🐞 +description: File a bug report +title: "[Bug]: " +body: + - type: checkboxes + id: existing-issue + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true + - type: textarea + id: what-happened + attributes: + label: What happened? + description: A concise description of what you are experiencing. + placeholder: Tell us what you see! + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Add ScreenShots + description: Add sufficient ScreenShots to explain your issue. + - type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + - type: checkboxes + id: terms + attributes: + label: Record + options: + - label: "I agree to follow this project's Code of Conduct" + required: true + - label: "I'm a GSSOC contributor" + required: False + - label: "I want to work on this issue" + required: False + - label: "I'm willing to provide further clarification or assistance if needed." + required: False From e87c19c17b3be57036bc647bb5d9a75032865843 Mon Sep 17 00:00:00 2001 From: Tony Stark <73957207+TonyStark-47@users.noreply.github.com> Date: Sun, 12 May 2024 12:05:40 +0530 Subject: [PATCH 2/3] Update and rename feature_request.md to feature_request.yml Made this feature_request issue template visually appealing and added an issue form to make it easier for the contributor to raise it. --- .github/ISSUE_TEMPLATE/feature_request.md | 24 --------- .github/ISSUE_TEMPLATE/feature_request.yml | 59 ++++++++++++++++++++++ 2 files changed, 59 insertions(+), 24 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index b5e5adb..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -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. - -What problem is this feature trying to solve? - -How do we know when the feature is complete? diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..7b50700 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,59 @@ +name: ✨ Feature Request +description: Suggest a feature +title: "[Feature Request]: " +body: + - type: checkboxes + id: existing-issue + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for this feature. + options: + - label: I have searched the existing issues + required: true + - type: textarea + id: feature-description + attributes: + label: Feature Description + description: Please provide a detailed description of the feature you are requesting. + placeholder: Describe the new feature or enhancement you'd like to see. + validations: + required: true + - type: textarea + id: use-case + attributes: + label: Use Case + description: How would this feature enhance your use of the project? + placeholder: Describe a specific use case or scenario where this feature would be beneficial. + validations: + required: true + - type: textarea + id: benefits + attributes: + label: Benefits + description: What benefits would this feature bring to the project or community? + placeholder: Explain the advantages of implementing this feature. + - type: dropdown + id: priority + attributes: + label: Priority + description: How important is this feature to you? + options: + - High + - Medium + - Low + default: 0 + validations: + required: true + - type: checkboxes + id: terms + attributes: + label: Record + options: + - label: "I agree to follow this project's Code of Conduct" + required: true + - label: "I'm a GSSOC contributor" + required: False + - label: "I want to work on this issue" + required: False + - label: "I'm willing to provide further clarification or assistance if needed." + required: False From c418248efb7e8981f3eb2ae9e7aa65f5ee83add2 Mon Sep 17 00:00:00 2001 From: Tony Stark <73957207+TonyStark-47@users.noreply.github.com> Date: Sun, 12 May 2024 12:08:10 +0530 Subject: [PATCH 3/3] Create documentation_update.yml Made this 'documentation_update" template and added an issue form to make it easier for the contributor to raise it. --- .../ISSUE_TEMPLATE/documentation_update.yml | 61 +++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/documentation_update.yml diff --git a/.github/ISSUE_TEMPLATE/documentation_update.yml b/.github/ISSUE_TEMPLATE/documentation_update.yml new file mode 100644 index 0000000..a31c299 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_update.yml @@ -0,0 +1,61 @@ +name: 📝 Documentation Update +description: Improve Documentation +title: "[Documentation Update]: " +body: + - type: checkboxes + id: existing-issue + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the updates you want to make. + options: + - label: I have searched the existing issues + required: true + - type: textarea + id: issue-description + attributes: + label: Issue Description + description: Please provide a clear description of the documentation update you are suggesting. + placeholder: Describe the improvement or correction you'd like to see in the documentation. + validations: + required: true + - type: textarea + id: suggested-change + attributes: + label: Suggested Change + description: Provide details of the proposed change to the documentation. + placeholder: Explain how the documentation should be updated or corrected. + validations: + required: true + - type: textarea + id: rationale + attributes: + label: Rationale + description: Why is this documentation update necessary or beneficial? + placeholder: Explain the importance or reasoning behind the suggested change. + validations: + required: False + - type: dropdown + id: urgency + attributes: + label: Urgency + description: How urgently do you believe this documentation update is needed? + options: + - High + - Medium + - Low + default: 0 + validations: + required: true + - type: checkboxes + id: terms + attributes: + label: Record + options: + - label: "I agree to follow this project's Code of Conduct" + required: true + - label: "I'm a GSSOC contributor" + required: False + - label: "I want to work on this issue" + required: False + - label: "I'm willing to provide further clarification or assistance if needed." + required: False