Skip to content

Commit 98da259

Browse files
committed
chore: improved templates for bug report and feature requests
Signed-off-by: fastlorenzo <[email protected]>
1 parent a80d638 commit 98da259

File tree

2 files changed

+57
-20
lines changed

2 files changed

+57
-20
lines changed
Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,43 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
4-
title: "[BUG]"
3+
about: Create a report to help us improve the Mailu Helm chart
4+
title: "[BUG] - "
55
labels: bug
6-
assignees: ''
7-
6+
assignees: ""
87
---
98

109
**Describe the bug**
11-
A clear and concise description of what the bug is.
10+
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).
11+
12+
**To Reproduce**
13+
Steps to reproduce the behavior (include specific Helm or Kubernetes commands if applicable):
14+
15+
1. Go to '...'
16+
2. Run command '...'
17+
3. Observe output '...'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Environment (please complete the following information):**
24+
25+
- **Helm Chart Version**: [e.g., 1.0.0]
26+
- **Helm Version**: [e.g., v3.12.0]
27+
- **Kubernetes Version**: [e.g., 1.21.1]
28+
- **Kubernetes Platform**: [e.g., GKE, Rancher2, EKS, AKS, Minikube]
29+
- **Mailu Version**: [e.g., 1.7]
30+
31+
**Values.yaml Configuration**
32+
Please provide your `values.yaml` configuration file or the relevant parts of it (ensure sensitive data is redacted).
1233

13-
**Environment**
14-
- Kubernetes Platform [e.g. GKE, Rancher2, ...]
34+
```yaml
35+
# Example:
36+
mailu:
37+
domain: "example.com"
38+
secretKey: "<redacted>"
39+
...
1540

16-
**Additional context**
17-
Add any other context about the problem here.
41+
**Additional information**
42+
Add any other context about the problem here, such as logs, error messages, or configurations.
43+
```
Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,31 @@
11
---
22
name: Feature request
33
about: Suggest an idea for this project
4-
title: ''
4+
title: "[FEATURE] - "
55
labels: enhancement
6-
assignees: ''
7-
6+
assignees: ""
87
---
98

10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
**Summary**
10+
Provide a short and clear summary of the feature request.
11+
12+
**Problem Statement**
13+
Is your feature request related to a problem? Please describe it in detail. For example, "I'm always frustrated when [...]"
14+
15+
**Proposed Solution**
16+
Describe the solution you'd like in detail. Highlight how it would solve the problem or improve the project.
17+
18+
**Alternatives Considered**
19+
Describe any alternative solutions or approaches you have thought about, and explain why they may or may not be suitable.
20+
21+
**Use Cases**
22+
Provide examples of use cases or scenarios where this feature would be beneficial. This helps illustrate its value.
1223

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
24+
**Impact**
25+
Describe the potential impact of the feature. How will it benefit users, improve workflows, or enhance the project?
1526

16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
27+
**Additional Context**
28+
Add any other relevant context, screenshots, or resources that might help clarify or support your feature request.
1829

19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
30+
**Priority**
31+
How important is this feature to you? (e.g., Low, Medium, High, Critical)

0 commit comments

Comments
 (0)