From edbd6e81b9445e4afdbdd421b9325087e0c321e8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CSibam?= <“sibampaulsp2@gmail.com”> Date: Tue, 1 Oct 2024 09:13:26 +0530 Subject: [PATCH 1/2] [FEATURE]-Added issue & PR templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 46 +++++++++++++++++++ .../ISSUE_TEMPLATE/documentation_update.yml | 41 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 33 +++++++++++++ .github/PR_Template.yml | 30 ++++++++++++ 4 files changed, 150 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation_update.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/PR_Template.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..d2ace3d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,46 @@ +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 want to work on this issue" + required: False + - label: "I'm willing to provide further clarification or assistance if needed." + required: False diff --git a/.github/ISSUE_TEMPLATE/documentation_update.yml b/.github/ISSUE_TEMPLATE/documentation_update.yml new file mode 100644 index 0000000..aa7d7d3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_update.yml @@ -0,0 +1,41 @@ +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: checkboxes + id: terms + attributes: + label: Record + options: + - label: "I agree to follow this project's Code of Conduct" + required: true + - label: "I want to work on this issue" + required: False + - label: "I'm willing to provide further clarification or assistance if needed." + required: False diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..1018298 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,33 @@ +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: checkboxes + id: terms + attributes: + label: Record + options: + - label: "I agree to follow this project's Code of Conduct" + required: true + - label: "I want to work on this issue" + required: False + - label: "I'm willing to provide further clarification or assistance if needed." + required: False diff --git a/.github/PR_Template.yml b/.github/PR_Template.yml new file mode 100644 index 0000000..e42d0be --- /dev/null +++ b/.github/PR_Template.yml @@ -0,0 +1,30 @@ +--- +name: Pull Request Template +about: Use this template for your pull requests +title: "[PR] Title of your pull request" +labels: enhancement, documentation +assignees: '' + +--- + +## Description + +Please include a summary of the changes and the related issue number if applicable. + +## Related Issues + +- Closes # (issue) + +## Changes Made + +- List out changes made in this PR. +- Include any relevant details or explanations. + +## Checklist + +- [ ] I have read the contributing guidelines. +- [ ] My code follows the style guidelines of this project. +- [ ] I have performed a self-review of my code. +- [ ] I have commented my code, particularly in hard-to-understand areas. +- [ ] I have made corresponding changes to the documentation. +- [ ] My changes generate no new warnings. From e05c4f741fbb180be31a9574649343f017fde642 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CSibam?= <“sibampaulsp2@gmail.com”> Date: Tue, 1 Oct 2024 09:44:35 +0530 Subject: [PATCH 2/2] Docs - Adding issue templates --- .github/PR_Template.yml | 30 ------------------------------ 1 file changed, 30 deletions(-) delete mode 100644 .github/PR_Template.yml diff --git a/.github/PR_Template.yml b/.github/PR_Template.yml deleted file mode 100644 index e42d0be..0000000 --- a/.github/PR_Template.yml +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: Pull Request Template -about: Use this template for your pull requests -title: "[PR] Title of your pull request" -labels: enhancement, documentation -assignees: '' - ---- - -## Description - -Please include a summary of the changes and the related issue number if applicable. - -## Related Issues - -- Closes # (issue) - -## Changes Made - -- List out changes made in this PR. -- Include any relevant details or explanations. - -## Checklist - -- [ ] I have read the contributing guidelines. -- [ ] My code follows the style guidelines of this project. -- [ ] I have performed a self-review of my code. -- [ ] I have commented my code, particularly in hard-to-understand areas. -- [ ] I have made corresponding changes to the documentation. -- [ ] My changes generate no new warnings.