Skip to content

Commit 310578c

Browse files
feat: updated the templates
1 parent eeb32f2 commit 310578c

File tree

3 files changed

+8
-67
lines changed

3 files changed

+8
-67
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,16 @@
22
name: Bug report
33
about: Create a report to help us improve
44
title: ''
5-
labels: ''
5+
labels: 'bug'
66
assignees: ''
77

88
---
99

1010
**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
11+
A clear and concise description of what the bug/unintended behavior is.
1912

2013
**Expected behavior**
2114
A clear and concise description of what you expected to happen.
2215

2316
**Screenshots**
2417
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.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,13 @@
22
name: Feature request
33
about: Suggest an idea for this project
44
title: ''
5-
labels: ''
5+
labels: 'enhancement'
66
assignees: ''
77

88
---
99

10-
**Is your feature request related to a problem? Please describe.**
10+
**The Problem**
1111
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1212

13-
**Describe the solution you'd like**
13+
**Possible solutions**
1414
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: 3 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,6 @@
11
# Description
2+
Please include a summary of the changes and the related issue. Please also include relevant motivation and context.
23

3-
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
4+
Fixes # (link issue here if applicable)
45

5-
Fixes # (issue)
6-
7-
## Type of change
8-
9-
Please delete options that are not relevant.
10-
11-
- [ ] Bug fix (non-breaking change which fixes an issue)
12-
- [ ] New feature (non-breaking change which adds functionality)
13-
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14-
- [ ] This change requires a documentation update
15-
16-
# How Has This Been Tested?
17-
18-
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
19-
20-
- [ ] Test A
21-
- [ ] Test B
22-
23-
**Test Configuration**:
24-
* Firmware version:
25-
* Hardware:
26-
* Toolchain:
27-
* SDK:
28-
29-
# Checklist:
30-
31-
- [ ] My code follows the style guidelines of this project
32-
- [ ] I have performed a self-review of my code
33-
- [ ] I have commented my code, particularly in hard-to-understand areas
34-
- [ ] I have made corresponding changes to the documentation
35-
- [ ] My changes generate no new warnings
36-
- [ ] I have added tests that prove my fix is effective or that my feature works
37-
- [ ] New and existing unit tests pass locally with my changes
38-
- [ ] Any dependent changes have been merged and published in downstream modules
6+
- [ ] I have updated the relevant documentation

0 commit comments

Comments
 (0)