Skip to content

Commit 8aa6e60

Browse files
authored
Merge pull request #545 from OneSignal/adding_pr_template
Adding a pr template
2 parents 287640b + e89a248 commit 8aa6e60

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
<!-- START -->
2+
# READ AND DELETE THIS SECTION BEFORE SUBMITTING PR
3+
* **Fill out each _REQUIRED_ section**
4+
* **Fill out _OPTIONAL_ sections, remove section if it doesn't apply to your PR**
5+
* **Read and fill out each of the checklists below**
6+
* **Remove this section after reading**
7+
<!-- END -->
8+
9+
# Description
10+
## One Line Summary
11+
**REQUIRED** - Very short description that summaries the changes in this PR.
12+
13+
## Details
14+
15+
### Motivation
16+
**REQUIRED -** Why is this code change being made? Or what is the goal of this PR? Examples: Fixes a specific bug, provides additional logging to debug future issues, feature to allow X.
17+
18+
### Scope
19+
**RECOMMEND - OPTIONAL -** What is intended to be effected. What is known not to change. Example: Notifications are grouped when parameter X is set, not enabled by default.
20+
21+
### OPTIONAL - Other
22+
**OPTIONAL -** Feel free to add any other sections or sub-sections that can explain your PR better.
23+
24+
# Testing
25+
## Unit testing
26+
**OPTIONAL -** Explain unit tests added, if not clear in the code.
27+
28+
## Manual testing
29+
**RECOMMEND - OPTIONAL -** Explain what scenarios were tested and the environment.
30+
Example: Tested opening a notification while the app was foregrounded, app build with Android Studio 2020.3 with a fresh install of the OneSignal example app on a Pixel 6 with Android 12.
31+
32+
# Affected code checklist
33+
- [ ] Notifications
34+
- [ ] Display
35+
- [ ] Open
36+
- [ ] Push Processing
37+
- [ ] Confirm Deliveries
38+
- [ ] Outcomes
39+
- [ ] Sessions
40+
- [ ] In-App Messaging
41+
- [ ] REST API requests
42+
- [ ] Public API changes
43+
44+
# Checklist
45+
## Overview
46+
- [ ] I have filled out all **REQUIRED** sections above
47+
- [ ] PR does one thing
48+
- If it is hard to explain how any codes changes are related to each other then it most likely needs to be more than one PR
49+
- [ ] Any Public API changes are explained in the PR details and conform to existing APIs
50+
51+
## Testing
52+
- [ ] I have included test coverage for these changes, or explained why they are not needed
53+
- [ ] All automated tests pass, or I explained why that is not possible
54+
- [ ] I have personally tested this on my device, or explained why that is not possible
55+
56+
## Final pass
57+
- [ ] Code is as readable as possible.
58+
- Simplify with less code, followed by splitting up code into well named functions and variables, followed by adding comments to the code.
59+
- [ ] I have reviewed this PR myself, ensuring it meets each checklist item
60+
- WIP (Work In Progress) is ok, but explain what is still in progress and what you would like feedback on. Start the PR title with "WIP" to indicate this.

0 commit comments

Comments
 (0)