Skip to content

Commit df0a711

Browse files
authored
Update issue templates
1 parent 8fef053 commit df0a711

File tree

2 files changed

+85
-0
lines changed

2 files changed

+85
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
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. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
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**
38+
Add any other context about the problem here.
+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement, good first issue
6+
assignees: ''
7+
8+
---
9+
10+
# Description
11+
12+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
13+
14+
Fixes # (issue)
15+
16+
## Type of change
17+
18+
Please delete options that are not relevant.
19+
20+
- [ ] Bug fix (non-breaking change which fixes an issue)
21+
- [ ] New feature (non-breaking change which adds functionality)
22+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
23+
- [ ] This change requires a documentation update
24+
25+
# How Has This Been Tested?
26+
27+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
28+
29+
- [ ] Test A
30+
- [ ] Test B
31+
32+
**Test Configuration**:
33+
* Firmware version:
34+
* Hardware:
35+
* Toolchain:
36+
* SDK:
37+
38+
# Checklist:
39+
40+
- [ ] My code follows the style guidelines of this project
41+
- [ ] I have performed a self-review of my own code
42+
- [ ] I have commented my code, particularly in hard-to-understand areas
43+
- [ ] I have made corresponding changes to the documentation
44+
- [ ] My changes generate no new warnings
45+
- [ ] I have added tests that prove my fix is effective or that my feature works
46+
- [ ] New and existing unit tests pass locally with my changes
47+
- [ ] Any dependent changes have been merged and published in downstream modules

0 commit comments

Comments
 (0)