Skip to content

Commit

Permalink
chore: improved templates for bug report and feature requests
Browse files Browse the repository at this point in the history
Signed-off-by: fastlorenzo <[email protected]>
  • Loading branch information
fastlorenzo committed Dec 27, 2024
1 parent a80d638 commit 98da259
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 20 deletions.
44 changes: 35 additions & 9 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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: "<redacted>"
...

**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.
```
33 changes: 22 additions & 11 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 98da259

Please sign in to comment.