Skip to content

Commit 9fe6e3d

Browse files
authored
Add Issue Templates and Pull Request Templates (#56)
* Update issue templates * chore: Adds PR template * Update .github/ISSUE_TEMPLATE/bug_report.md
1 parent 066fb47 commit 9fe6e3d

File tree

3 files changed

+79
-0
lines changed

3 files changed

+79
-0
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Do something unusual to Kubernetes
16+
2. Make sure there's a specific cluster state present
17+
3. Run test plan: <link to test plan>
18+
4. See error: <paste output of error here using GitHub markdown code block styling>
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Test Plan**
24+
If applicable, add your test plan(s) and link them here.
25+
26+
**Development Environment (please complete the following information):**
27+
Runner: (if applicable)
28+
- OS:
29+
- Run in Docker?: No/Yes(Container Tag)
30+
- Kubernetes Version:
31+
32+
Probe:
33+
- OS:
34+
- Run in Docker?: No/Yes(Container Tag)
35+
36+
**Additional context**
37+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[FEAT] "
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
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 [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## Description
2+
3+
<!-- Provide a brief description of the changes in this PR -->
4+
5+
## Changes
6+
7+
<!-- List the specific changes made in this PR. Each change should be a minimal and accurate solution to an identified problem. -->
8+
9+
## Testing
10+
11+
<!-- Describe how these changes have been tested -->
12+
13+
## Special Considerations
14+
15+
<!-- Optional: Call out anything that reviewers should pay special attention to -->
16+
17+
## Checklist
18+
19+
- [ ] My changes are minimal and accurately solve an identified problem
20+
- [ ] I have added tests that prove my fix is effective or that my feature works
21+
- [ ] I have updated the documentation accordingly
22+
- [ ] My changes generate no new warnings

0 commit comments

Comments
 (0)