From 99a396bd49a2c120fcac6e8a3ceaa79a0aff1455 Mon Sep 17 00:00:00 2001 From: Razzat Date: Sun, 22 Sep 2024 13:05:19 +0545 Subject: [PATCH 1/4] Add: template for bug-report --- .github/ISSUE_TEMPLATE/bug-report.yml | 37 +++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..93aa16b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,37 @@ +name: Bug Report +description: File a bug report. +title: "[Bug]: " +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: what-happened + attributes: + label: What happened? + placeholder: Tell us what you see! + value: "A bug happened!" + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: What was expected? + placeholder: Tell us what you expected! + value: "X didn't work!" + validations: + required: true + - type: textarea + id: logs + attributes: + label: Relevant log output. + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + validations: + required: false + - type: textarea + id: more + attributes: + label: Anything you'd like to reference? + description: Please add any links or references to this issue that could be of help. From 35c27b8f033ca4e72735af6c494c418fb8475a9c Mon Sep 17 00:00:00 2001 From: Razzat Date: Sun, 22 Sep 2024 13:19:53 +0545 Subject: [PATCH 2/4] Add: labels for templates --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 93aa16b..328ead2 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,11 +1,13 @@ name: Bug Report description: File a bug report. +labels: ["bug"] title: "[Bug]: " body: - type: markdown attributes: value: | Thanks for taking the time to fill out this bug report! + Please make sure this won't be a duplicate. - type: textarea id: what-happened attributes: From f28a92c727b8de96db27aca063057955bcc9c0b8 Mon Sep 17 00:00:00 2001 From: Razzat Date: Sun, 22 Sep 2024 13:31:01 +0545 Subject: [PATCH 3/4] Add: template for feature-request --- .github/ISSUE_TEMPLATE/feature-request.yml | 31 ++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..16bb978 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,31 @@ +name: Feature Request +description: File a feature request. +labels: ["enhancement"] +title: "[Enhancement]: " +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this form! + Please make sure this won't a duplicate. + - type: checkboxes + attributes: + label: Type + description: | + Please specify the nature of feature you're requesting. + If not sure, check 'others'. + options: + - label: Documentation + required: false + - label: Codebase + - label: UI/UX + - label: Others + - type: textarea + attributes: + label: Feature(s). + description: Mention what you'd like to see. + placeholder: Add a section for blogs. + - type: textarea + attributes: + label: Additional context. + description: Anything you'd like to add that'll help us? From 0c3467b15272efd0961f0bff908ba4f3935309b8 Mon Sep 17 00:00:00 2001 From: Razzat Date: Sun, 22 Sep 2024 14:42:18 +0545 Subject: [PATCH 4/4] Add: changes to feature-request & pull-request - added placeholders for feature-request - added minimal template for pull-requests --- .github/ISSUE_TEMPLATE/feature-request.yml | 4 ++-- .github/pull_request_template.md | 21 +++++++++++++++++++++ 2 files changed, 23 insertions(+), 2 deletions(-) create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 16bb978..ec565d0 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -23,8 +23,8 @@ body: - type: textarea attributes: label: Feature(s). - description: Mention what you'd like to see. - placeholder: Add a section for blogs. + description: Mention what you'd like to suggest. + placeholder: For eg:Add a section for blogs. - type: textarea attributes: label: Additional context. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..1bb1ad4 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,21 @@ +**Remove anything that's not been modified from this template.** + +## Checklist +- [ ] Documentation is updated if necessary. +- [ ] The change(s) has/have been tested locally. + +## Description +A brief summary of the changes introduced in this pull request. + +## Changes Made +- Main Change 1: Short description +- Main Change 2: Short description + +## Related Issues +Closes #issue-number + +## Notes for Reviewers(Optional) +Any additional context or insights for the reviewer. + +## Screenshots / Media (Optional) +If applicable, insert images or videos demonstrating the changes.