Skip to content

Commit e365751

Browse files
author
Apostolos Lazidis
committed
docs: Update issue template
1 parent 3c52e64 commit e365751

File tree

3 files changed

+55
-40
lines changed

3 files changed

+55
-40
lines changed
Lines changed: 19 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,32 @@
11
---
2-
name: Bug report
3-
about: Create a report to help us improve
4-
title: ''
5-
labels: ''
6-
assignees: ''
7-
2+
name: 🐞 Bug Report
3+
about: Create a report to help improve Kube-NetLag
4+
title: "[BUG] <Short description of the bug>"
5+
labels: bug
6+
assignees:
87
---
98

10-
**Describe the bug**
9+
## **🐛 Describe the Bug**
1110
A clear and concise description of what the bug is.
1211

13-
**To Reproduce**
12+
## **📌 To Reproduce**
1413
Steps to reproduce the behavior:
1514
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
18-
4. See error
15+
2. Click on '...'
16+
3. Scroll down to '...'
17+
4. See the error
1918

20-
**Expected behavior**
19+
## **Expected Behavior**
2120
A clear and concise description of what you expected to happen.
2221

23-
**Screenshots**
22+
## **📸 Screenshots (if applicable)**
2423
If applicable, add screenshots to help explain your problem.
2524

26-
**Desktop (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
30-
31-
**Smartphone (please complete the following information):**
32-
- Device: [e.g. iPhone6]
33-
- OS: [e.g. iOS8.1]
34-
- Browser [e.g. stock browser, safari]
35-
- Version [e.g. 22]
36-
37-
**Additional context**
25+
## **📜 Additional Context**
3826
Add any other context about the problem here.
27+
28+
---
29+
🔹 **Issue Defaults:**
30+
- **Issue Title Prefix:** `[BUG]`
31+
- **Labels:** `bug`
32+
- **Assignees:** _(Add maintainers who should review bugs)_

.github/ISSUE_TEMPLATE/custom.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,31 @@
11
---
2-
name: Custom issue template
3-
about: Describe this issue template's purpose here.
4-
title: ''
2+
name: 📝 General Issue
3+
about: Report a bug, ask a question, or suggest an improvement.
4+
title: "[Issue] <Short description of the issue>"
55
labels: ''
66
assignees: ''
7-
87
---
98

9+
## **🔍 Issue Description**
10+
Provide a clear and concise description of the issue.
11+
12+
## **📌 Steps to Reproduce**
13+
1. Go to '...'
14+
2. Click on '...'
15+
3. See the error or unexpected behavior.
16+
17+
## **💡 Expected Behavior**
18+
Describe what you expected to happen.
19+
20+
## **🖥️ Environment Details**
21+
| **Component** | **Version** |
22+
|--------------|------------|
23+
| OS | [e.g. Ubuntu 22.04] |
24+
| Kubernetes Version | [e.g. 1.26] |
25+
| Helm Version | [e.g. 3.11.0] |
26+
27+
## **📸 Screenshots & Logs**
28+
If applicable, add screenshots or logs to help explain the problem.
1029

30+
## **📎 Additional Context**
31+
Add any other context about the issue, such as related PRs, issues, or workarounds you've tried.
Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
2-
name: Feature request
3-
about: Suggest an idea for this project
4-
title: ''
5-
labels: ''
2+
name: 🚀 Feature Request
3+
about: Suggest an idea to improve Kube-NetLag
4+
title: "[Feature] <Short description of the feature>"
5+
labels: enhancement
66
assignees: ''
7-
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+
## **🚀 Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is.
11+
Ex. *"I'm always frustrated when [...]"*
1212

13-
**Describe the solution you'd like**
13+
## **💡 Describe the solution you'd like**
1414
A clear and concise description of what you want to happen.
1515

16-
**Describe alternatives you've considered**
16+
## **🔄 Describe alternatives you've considered**
1717
A clear and concise description of any alternative solutions or features you've considered.
1818

19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
19+
## **📸 Additional context**
20+
Add any other relevant context, screenshots, or references to related issues.

0 commit comments

Comments
 (0)