Skip to content

Commit df329ef

Browse files
author
KArtHiK
committed
Add Issue templates for bug report, features and pull request template
1 parent 014fa69 commit df329ef

File tree

4 files changed

+269
-0
lines changed

4 files changed

+269
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
name: 🐞 Bug Report
2+
description: "File a new bug report."
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
> [!IMPORTANT]
10+
> **Please ensure you are using the latest version of Cloudness before submitting an issue, as the bug may have already been fixed in a recent update.**
11+
12+
Thanks for taking the time to fill out this bug report! The more details you provide, the faster we can help.
13+
14+
- type: textarea
15+
attributes:
16+
label: Description
17+
description: A clear and concise description of what the bug is.
18+
placeholder: Describe the bug...
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
attributes:
24+
label: Error Message and Logs
25+
description: Provide any error messages or relevant log output.
26+
render: shell
27+
validations:
28+
required: false
29+
30+
- type: textarea
31+
attributes:
32+
label: Steps to Reproduce
33+
description: Please provide a step-by-step guide to reproduce the issue. Be as detailed as possible.
34+
value: |
35+
1.
36+
2.
37+
3.
38+
4.
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
attributes:
44+
label: Expected Behavior
45+
description: What did you expect to happen?
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
attributes:
51+
label: Actual Behavior
52+
description: What actually happened instead?
53+
validations:
54+
required: true
55+
56+
- type: input
57+
attributes:
58+
label: Cloudness Version
59+
description: Run `cloudness version` or check your deployment. Found in the UI footer or logs.
60+
placeholder: "v1.0.0"
61+
validations:
62+
required: true
63+
64+
- type: dropdown
65+
attributes:
66+
label: Installation Type
67+
description: How is Cloudness deployed?
68+
options:
69+
- Self-hosted (Kubernetes)
70+
- Other
71+
validations:
72+
required: true
73+
74+
- type: input
75+
attributes:
76+
label: Kubernetes Version
77+
description: Run `kubectl version --short` and provide the server version.
78+
placeholder: "v1.28.0"
79+
validations:
80+
required: false
81+
82+
- type: dropdown
83+
attributes:
84+
label: Kubernetes Distribution
85+
description: What Kubernetes distribution are you using?
86+
options:
87+
- k3s
88+
- k8s (vanilla)
89+
- EKS (AWS)
90+
- GKE (Google)
91+
- AKS (Azure)
92+
- minikube
93+
- kind
94+
- Rancher
95+
- OpenShift
96+
- Other
97+
validations:
98+
required: false
99+
100+
- type: input
101+
attributes:
102+
label: Operating System
103+
description: Run `cat /etc/os-release` or provide your OS version.
104+
placeholder: "Ubuntu 22.04"
105+
validations:
106+
required: false
107+
108+
- type: input
109+
attributes:
110+
label: Browser (if UI issue)
111+
description: Provide browser name and version if this is a UI-related issue.
112+
placeholder: "Chrome 120"
113+
validations:
114+
required: false
115+
116+
- type: textarea
117+
attributes:
118+
label: Additional Context
119+
description: Any other relevant information, screenshots, or context about the issue.
120+
validations:
121+
required: false
122+
123+
- type: checkboxes
124+
attributes:
125+
label: Checklist
126+
description: Please confirm the following before submitting.
127+
options:
128+
- label: I have searched existing issues to ensure this bug hasn't been reported.
129+
required: true
130+
- label: I am using the latest version of Cloudness (or have noted my version above).
131+
required: true
132+
- label: I have provided all the information needed to reproduce this issue.
133+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 📖 Documentation
4+
url: https://docs.cloudness.io
5+
about: Check the documentation for answers to common questions
6+
- name: 💬 Discussions
7+
url: https://github.com/cloudness-io/cloudness/discussions
8+
about: Ask questions and discuss with the community
9+
- name: 🔒 Security Vulnerability
10+
url: https://github.com/cloudness-io/cloudness/security/advisories/new
11+
about: Report security vulnerabilities privately (do not use public issues)

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: ✨ Feature Request
2+
description: "Suggest an idea or enhancement for Cloudness."
3+
title: "[Feature]: "
4+
labels: ["enhancement", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting an improvement! Please fill out the details below to help us understand your request.
10+
11+
- type: textarea
12+
attributes:
13+
label: Problem Statement
14+
description: Is your feature request related to a problem? Please describe.
15+
placeholder: "I'm always frustrated when..."
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
attributes:
21+
label: Proposed Solution
22+
description: Describe the solution you'd like. Be as detailed as possible.
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
attributes:
28+
label: Alternatives Considered
29+
description: Describe any alternative solutions or workarounds you've considered.
30+
validations:
31+
required: false
32+
33+
- type: dropdown
34+
attributes:
35+
label: Feature Area
36+
description: What area of Cloudness does this relate to?
37+
options:
38+
- Deployment / CI/CD
39+
- UI / Dashboard
40+
- CLI
41+
- Authentication / Authorization
42+
- Templates
43+
- Kubernetes Integration
44+
- Database / Storage
45+
- Logging / Monitoring
46+
- Documentation
47+
- Other
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
attributes:
53+
label: Use Case
54+
description: Describe your use case and how this feature would benefit you and others.
55+
validations:
56+
required: false
57+
58+
- type: textarea
59+
attributes:
60+
label: Additional Context
61+
description: Add any other context, mockups, screenshots, or examples about the feature request.
62+
validations:
63+
required: false
64+
65+
- type: checkboxes
66+
attributes:
67+
label: Checklist
68+
description: Please confirm the following before submitting.
69+
options:
70+
- label: I have searched existing issues to ensure this feature hasn't been requested.
71+
required: true
72+
- label: I would be willing to help implement this feature.
73+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
## Description
2+
3+
<!-- Describe your changes in detail -->
4+
5+
## Related Issue
6+
7+
<!-- Link to the issue this PR addresses -->
8+
Fixes #
9+
10+
## Type of Change
11+
12+
<!-- Mark the relevant option with an "x" -->
13+
14+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
15+
- [ ] ✨ New feature (non-breaking change which adds functionality)
16+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to change)
17+
- [ ] 📝 Documentation update
18+
- [ ] 🔧 Configuration change
19+
- [ ] ♻️ Refactoring (no functional changes)
20+
- [ ] 🧪 Test update
21+
22+
## How Has This Been Tested?
23+
24+
<!-- Describe the tests you ran to verify your changes -->
25+
26+
- [ ] Unit tests
27+
- [ ] Integration tests
28+
- [ ] Manual testing
29+
30+
**Test Environment:**
31+
32+
- Kubernetes Version:
33+
- OS:
34+
35+
## Screenshots (if applicable)
36+
37+
<!-- Add screenshots to help explain your changes -->
38+
39+
## Checklist
40+
41+
- [ ] My code follows the project's style guidelines
42+
- [ ] I have performed a self-review of my code
43+
- [ ] I have commented my code, particularly in hard-to-understand areas
44+
- [ ] I have made corresponding changes to the documentation
45+
- [ ] My changes generate no new warnings
46+
- [ ] I have added tests that prove my fix is effective or that my feature works
47+
- [ ] New and existing unit tests pass locally with my changes
48+
- [ ] Any dependent changes have been merged and published
49+
50+
## Additional Notes
51+
52+
<!-- Add any additional notes for reviewers -->

0 commit comments

Comments
 (0)