From 27496d30092ba0187cb6c886534450a721963341 Mon Sep 17 00:00:00 2001 From: Abhay Date: Tue, 28 Jan 2025 00:59:57 +0530 Subject: [PATCH] Add: Issue templates and pull_request.yml (#35) --- .github/ISSUE_TEMPLATE/bug_report.yml | 68 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 37 ++++++++++++ .github/pull_request_template.md | 34 +++++++++++ 3 files changed, 139 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..58c2d94 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,68 @@ +name: 🐛 Bug +description: Create a report to help us improve +title: "🐛 Bug: " +labels: ["🐛 Bug", "Status: Triage"] +body: +- type: textarea + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is + validations: + required: true +- type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior + placeholder: | + 1. Go to'...' + 2. Click on'...' + 3. Scroll down to'...' + 4. See error + validations: + required: true +- type: textarea + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen + validations: + required: true +- type: textarea + attributes: + label: Screenshots + description: | + If applicable, add screenshots to help explain your problem + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in + validations: + required: false +- type: textarea + attributes: + label: Device Information [optional] + description: | + examples: + - **OS**: Ubuntu 20.04 + - **Browser**: chrome + - **version**: 22 + value: | + - OS: + - Browser: + - version: + render: markdown + validations: + required: false +- type: dropdown + attributes: + label: Are you working on this issue? + options: + - 'Yes' + - 'No' + validations: + required: true +- type: dropdown + attributes: + label: Do you think this work might require an [Architectural Decision Record (ADR)]? (significant or noteworthy) + options: + - 'Yes' + - 'No' + validations: + required: true \ 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..f795639 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,37 @@ +name: ⭐️ Feature request +description: Suggest an idea for this project +title: "✨ Enhancement: " +labels: ["✨ Enhancement", "Status: Triage"] +body: +- type: textarea + attributes: + label: Is your feature request related to a problem? Please describe + description: A clear and concise description of what the problem is + validations: + required: true +- type: textarea + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen + validations: + required: true +- type: textarea + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered + validations: + required: false +- type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here + validations: + required: false +- type: dropdown + attributes: + label: Are you working on this? + options: + - 'Yes' + - 'No' + validations: + required: true \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..9383a07 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,34 @@ + + + + + +**What kind of change does this PR introduce?** + + + +**Issue Number:** + +- Closes #___ +- Related to #___ +- Others? + + +**Screenshots/videos:** + + + +**If relevant, did you update the documentation?** + + + +**Summary** + + + + +**Does this PR introduce a breaking change?** + + \ No newline at end of file