Skip to content

Commit bbdf49e

Browse files
authored
Merge pull request #46 from aicore/pr
Adding pull request template
2 parents 660e1a1 + f9796dd commit bbdf49e

File tree

3 files changed

+132
-8
lines changed

3 files changed

+132
-8
lines changed

.github/ISSUE_TEMPLATE/pull_request_template.md renamed to .github/PULL_REQUEST_TEMPLATE/bug_fix.md

+17-8
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
1+
---
2+
name: Bug fix
3+
about: Change which fixes an issue.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
19
# Description
210

3-
* Please include a summary of the change and which issue is addressed.
11+
* Please include a summary of the change.
412
* Please also include relevant motivation and context.
513
* List any dependencies that are required for this change.
614

7-
Fixes # (issue)
15+
Addresses issues #(issue)
816

917
## Type of change
1018

11-
Please delete options that are not relevant.
19+
**NB: ~~Please strike through options that are not applicable.~~**
1220

13-
- [ ] Bug fix (non-breaking change which fixes an issue)
14-
- [ ] New feature (non-breaking change which adds functionality)
15-
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
21+
- [ ] Breaking change (fix that would cause existing functionality to not work as expected)
1622
- [ ] This change requires a documentation update
1723

1824
# Sample Input and output
@@ -21,7 +27,10 @@ Please delete options that are not relevant.
2127

2228
# How Has This Been Tested?
2329

24-
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
30+
* Please describe the tests that you ran to verify your changes.
31+
* Provide instructions so we can reproduce.
32+
* Please also list any relevant details for your test configuration
33+
2534

2635
- [ ] Test A
2736
- [ ] Test B
@@ -34,7 +43,7 @@ Please describe the tests that you ran to verify your changes. Provide instructi
3443

3544
# Checklist:
3645

37-
Add N/A to items thata re not applicanble.
46+
**NB: ~~Please strike through options that are not applicable.~~**
3847

3948
- [ ] My code follows the style guidelines of this project
4049
- [ ] I have performed a self-review of my own code
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
name: New Feature
3+
about: Change which adds functionality
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
# Description
10+
11+
* Please include a summary of the change.
12+
* Please also include relevant motivation and context.
13+
* List any dependencies that are required for this change.
14+
15+
Fixes #(issue)
16+
17+
## Type of change
18+
**NB: ~~Please strike through options that are not applicable.~~**
19+
- [ ] non-breaking change which fixes an issue
20+
- [ ] Breaking change (feature that would cause existing functionality to not work as expected)
21+
- [ ] This change requires a documentation update
22+
23+
# Sample Input and output
24+
* Provide screenshots or videos.
25+
* Or provide code block Input output if run on text terminal as below.
26+
```
27+
$ code block Input output on text terminal.
28+
output
29+
```
30+
31+
# How Has This Been Tested?
32+
33+
* Please describe the tests that you ran to verify your changes.
34+
* Provide instructions so we can reproduce.
35+
* Please also list any relevant details for your test configuration
36+
37+
- [ ] Test A
38+
- [ ] Test B
39+
40+
**Test Configuration**:
41+
* Firmware version:
42+
* Hardware:
43+
* Toolchain:
44+
* SDK:
45+
46+
# Checklist:
47+
48+
**NB: ~~Please strike through options that are not applicable.~~**
49+
50+
- [ ] My code follows the style guidelines of this project
51+
- [ ] I have performed a self-review of my own code
52+
- [ ] I have commented my code, particularly in hard-to-understand areas
53+
- [ ] I have made corresponding changes to the documentation
54+
- [ ] My changes generate no new warnings
55+
- [ ] I have added tests that prove my fix is effective or that my feature works
56+
- [ ] New and existing unit tests pass locally with my changes
57+
- [ ] Any dependent changes have been merged and published in downstream modules
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
name: Remove Feature
3+
about: Change which removes existing functionality
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
# Description
10+
11+
* Please include a summary of the change.
12+
* Please also include relevant motivation and context.
13+
* List any dependencies that are required for this change.
14+
15+
Fixes #(issue)
16+
17+
## Type of change
18+
**NB: ~~Please strike through options that are not applicable.~~**
19+
- [ ] non-breaking change which fixes an issue
20+
- [ ] Breaking change (feature that would cause existing functionality to not work as expected)
21+
- [ ] This change requires a documentation update
22+
23+
# Sample Input and output
24+
* Provide screenshots or videos.
25+
* Or provide code block Input output if run on text terminal as below.
26+
```
27+
$ code block Input output on text terminal.
28+
output
29+
```
30+
31+
# How Has This Been Tested?
32+
33+
* Please describe the tests that you ran to verify your changes.
34+
* Provide instructions so we can reproduce.
35+
* Please also list any relevant details for your test configuration
36+
37+
38+
- [ ] Test A
39+
- [ ] Test B
40+
41+
**Test Configuration**:
42+
* Firmware version:
43+
* Hardware:
44+
* Toolchain:
45+
* SDK:
46+
47+
# Checklist:
48+
49+
**NB: ~~Please strike through options that are not applicable.~~**
50+
51+
- [ ] My code follows the style guidelines of this project
52+
- [ ] I have performed a self-review of my own code
53+
- [ ] I have commented my code, particularly in hard-to-understand areas
54+
- [ ] I have made corresponding changes to the documentation
55+
- [ ] My changes generate no new warnings
56+
- [ ] I have added tests that prove my fix is effective or that my feature works
57+
- [ ] New and existing unit tests pass locally with my changes
58+
- [ ] Any dependent changes have been merged and published in downstream modules

0 commit comments

Comments
 (0)