From 98da259e46bf366ca03d7a9d3352d74c5bff7c66 Mon Sep 17 00:00:00 2001 From: fastlorenzo Date: Fri, 27 Dec 2024 20:51:38 +0100 Subject: [PATCH] chore: improved templates for bug report and feature requests Signed-off-by: fastlorenzo --- .github/ISSUE_TEMPLATE/bug_report.md | 44 ++++++++++++++++++----- .github/ISSUE_TEMPLATE/feature_request.md | 33 +++++++++++------ 2 files changed, 57 insertions(+), 20 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index cf50e762..220a763f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,17 +1,43 @@ --- name: Bug report -about: Create a report to help us improve -title: "[BUG]" +about: Create a report to help us improve the Mailu Helm chart +title: "[BUG] - " labels: bug -assignees: '' - +assignees: "" --- **Describe the bug** -A clear and concise description of what the bug is. +A clear and concise description of what the bug is. Indicate if this is a regression (e.g., it worked in a previous version XX). + +**To Reproduce** +Steps to reproduce the behavior (include specific Helm or Kubernetes commands if applicable): + +1. Go to '...' +2. Run command '...' +3. Observe output '...' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Environment (please complete the following information):** + +- **Helm Chart Version**: [e.g., 1.0.0] +- **Helm Version**: [e.g., v3.12.0] +- **Kubernetes Version**: [e.g., 1.21.1] +- **Kubernetes Platform**: [e.g., GKE, Rancher2, EKS, AKS, Minikube] +- **Mailu Version**: [e.g., 1.7] + +**Values.yaml Configuration** +Please provide your `values.yaml` configuration file or the relevant parts of it (ensure sensitive data is redacted). -**Environment** - - Kubernetes Platform [e.g. GKE, Rancher2, ...] +```yaml +# Example: +mailu: + domain: "example.com" + secretKey: "" + ... -**Additional context** -Add any other context about the problem here. +**Additional information** +Add any other context about the problem here, such as logs, error messages, or configurations. +``` diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 11fc491e..bc27ee65 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,20 +1,31 @@ --- name: Feature request about: Suggest an idea for this project -title: '' +title: "[FEATURE] - " labels: enhancement -assignees: '' - +assignees: "" --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +**Summary** +Provide a short and clear summary of the feature request. + +**Problem Statement** +Is your feature request related to a problem? Please describe it in detail. For example, "I'm always frustrated when [...]" + +**Proposed Solution** +Describe the solution you'd like in detail. Highlight how it would solve the problem or improve the project. + +**Alternatives Considered** +Describe any alternative solutions or approaches you have thought about, and explain why they may or may not be suitable. + +**Use Cases** +Provide examples of use cases or scenarios where this feature would be beneficial. This helps illustrate its value. -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +**Impact** +Describe the potential impact of the feature. How will it benefit users, improve workflows, or enhance the project? -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +**Additional Context** +Add any other relevant context, screenshots, or resources that might help clarify or support your feature request. -**Additional context** -Add any other context or screenshots about the feature request here. +**Priority** +How important is this feature to you? (e.g., Low, Medium, High, Critical)