From d449710dc040fbe7cd2712addd9cd427980b194a Mon Sep 17 00:00:00 2001 From: Tony Stark <73957207+TonyStark-47@users.noreply.github.com> Date: Tue, 28 May 2024 21:50:59 +0530 Subject: [PATCH 1/3] Update and rename bug_report.md to bug_report.yml Added issue form for bug report. --- .github/ISSUE_TEMPLATE/bug_report.md | 16 -------- .github/ISSUE_TEMPLATE/bug_report.yml | 55 +++++++++++++++++++++++++++ 2 files changed, 55 insertions(+), 16 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 5554b0377..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: 'Bug Report: [[Brief Description of Bug]]' -labels: bug -assignees: '' - ---- - -* **Description:** Please describe the bug you encountered in detail. What were you doing when the bug occurred? What is the expected behavior? -* **Steps to Reproduce:** If possible, please provide step-by-step instructions on how to reproduce the bug. This will help us fix the issue more quickly. -* **Screenshots or Screencast:** If applicable, please attach screenshots or a screencast that demonstrates the bug. You can upload them to an external image/video hosting service and share the link here. -* **Version:** Please specify the version of CodeHarborHub you are using. -* **Browser/OS:** (Optional) Specify the browser and operating system you are using. -* **Additional Information:** (Optional) - * You can add any other relevant information that might help us diagnose the bug, such as error messages, console logs, or code snippets. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..034f9ea4e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,55 @@ +name: Bug report 🐞 +description: File a bug report +title: "[Bug]: " +labels: 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: Describe the bug + description: A concise description of what you are experiencing. + placeholder: Tell us what you see! + validations: + required: true + - type: textarea + id: expected-behaviour + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Add ScreenShots + description: Add sufficient ScreenShots to explain your issue. + - type: dropdown + id: devices + attributes: + label: On which device are you experiencing this bug? + multiple: true + options: + - Android + - iPhone + - Linux + - Chrome + - Windows + - type: checkboxes + id: terms + attributes: + label: Record + options: + - label: "I have read the Contributing Guidelines" + required: true + - label: "I'm a GSSOC'24 contributor" + required: False + - label: "I have starred the repository" + required: true From df303daeaa6dd48120e81423c30d2deb1fef5da5 Mon Sep 17 00:00:00 2001 From: Tony Stark <73957207+TonyStark-47@users.noreply.github.com> Date: Tue, 28 May 2024 21:52:57 +0530 Subject: [PATCH 2/3] Update and rename documentation.md to documentation.yml Added issue form for documentation. --- .github/ISSUE_TEMPLATE/documentation.md | 22 --------- .github/ISSUE_TEMPLATE/documentation.yml | 60 ++++++++++++++++++++++++ 2 files changed, 60 insertions(+), 22 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index 2faaa7ad3..000000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: 📝 Documentation -about: Propose changes and improvements to JobLane Docs. -title: '📝[Docs]: ' -labels: 'enhancement' -assignees: '' ---- - -**What Docs changes are you proposing?** -Provide a clear description of the changes you're proposing for the documentation. Are you suggesting corrections, clarifications, additions, or updates? - -**Why do the Docs need this improvement? What is the motivation for this change? How will this change benefit the community?** -Explain the motivation behind the proposed changes and how they will benefit the community or users of the documentation. - -**Describe the solution you'd like** -Provide a clear and concise description of the changes you'd like to see implemented in the documentation. - -**Describe alternatives you've considered** -If you've thought about alternative approaches or solutions, briefly describe them here. - -**Additional context** -Add any additional context, examples, or screenshots related to the proposed documentation changes. diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 000000000..9f713be1c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,60 @@ +name: 📝 Documentation Update +description: Improve Documentation +title: "[Documentation Update]: " +labels: 'enhancement' +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 have read the Contributing Guidelines" + required: true + - label: "I'm a GSSOC'24 contributor" + required: false + - label: "I have starred the repository" + required: true From 74c0e5dfc04131924b5396d011108ac6fd0f214f Mon Sep 17 00:00:00 2001 From: Tony Stark <73957207+TonyStark-47@users.noreply.github.com> Date: Tue, 28 May 2024 21:54:10 +0530 Subject: [PATCH 3/3] Update and rename feature_request.md to feature_request.yml Added issue form for feature request. --- .github/ISSUE_TEMPLATE/feature_request.md | 12 ----- .github/ISSUE_TEMPLATE/feature_request.yml | 63 ++++++++++++++++++++++ 2 files changed, 63 insertions(+), 12 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 8b32ffd38..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: 'Feature Request: [[Brief Description of Feature]]' -labels: enhancement -assignees: '' - ---- - -* **Description:** Describe the feature you would like to see added to CodeHarborHub. Explain how this feature would benefit users. -* **Use Case:** Provide a specific example of how you would use this feature. -* **Similar Features:** (Optional) If there are other platforms that offer a similar feature, mention them and explain how your proposed feature would be different or better. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..cac7ac7d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,63 @@ +name: ✨ Feature Request +description: Suggest a feature +title: "[Feature Request]: " +labels: enhancement +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: textarea + id: screenShots + attributes: + label: Add ScreenShots + description: If any... + - 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 have read the Contributing Guidelines" + required: true + - label: "I'm a GSSOC'24 contributor" + required: false + - label: "I have starred the repository" + required: true