From a537f814a9cfb65991181a50eac18bffe65c9ff4 Mon Sep 17 00:00:00 2001 From: bhanvimenghani Date: Tue, 12 Nov 2024 11:49:46 +0530 Subject: [PATCH] adds templates for bug and feature req --- .github/ISSUE_TEMPLATE/bug_report.md | 35 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 28 ++++++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..4961da0a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug Report +about: Create a report to help us improve +title: '[BUG] ' +labels: bug +assignees: '' +--- + +### Describe the Bug + +A clear and concise description of the issue. Include any relevant **images, JSON objects, logs, or error messages** to help us understand the problem. + +### Steps to Reproduce + +Provide step-by-step instructions to reproduce the issue: + +1. Go to '...' +2. Click on '...' +3. Enter '...' +4. See error + +### Expected Behavior + +A clear and concise description of what you expected to happen. + +### Actual Behavior + +Describe what actually happened, including any **error messages** or discrepancies observed. + +### Environment Details + +- **Cluster Information** (e.g., OpenShift, Kind, minikube): +- **Kruize Mode** (e.g., local, remote): +- **Browser** (if applicable): +- **Operating System** (e.g., macOS, Windows, Linux): diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..69e680f1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,28 @@ +--- +name: Feature Request +about: Suggest an idea for this project +title: '[FEATURE] ' +labels: enhancement +assignees: '' +--- + +### Problem Faced + +A clear and concise description of the problem or pain point. + +- Example: "I'm always frustrated when [...]" +- Please include any relevant **images, code snippets, YAML objects, or sample API details** to assist in understanding. + +### Expected Solution / Delivery Requirements + +A clear and concise description of the desired outcome or **definition of done** for this feature. + +- What is the end goal? +- How will success be measured? + +### Where to Start + +If you have some suggestions or initial thoughts on how this feature can be implemented, include them here. + +- Are there specific files, components, or modules to focus on? +- Any related documentation or existing functionality?