|
1 | 1 | <!-- START --> |
| 2 | + |
2 | 3 | # 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** |
| 4 | + |
| 5 | +- **Fill out each _REQUIRED_ section** |
| 6 | +- **Fill out _OPTIONAL_ sections, remove section if it doesn't apply to your PR** |
| 7 | +- **Read and fill out each of the checklists below** |
| 8 | +- **Remove this section after reading** |
7 | 9 | <!-- END --> |
8 | 10 |
|
9 | 11 | # Description |
| 12 | + |
10 | 13 | ## One Line Summary |
| 14 | + |
11 | 15 | **REQUIRED** - Very short description that summaries the changes in this PR. |
12 | 16 |
|
13 | 17 | ## Details |
14 | 18 |
|
15 | 19 | ### Motivation |
| 20 | + |
16 | 21 | **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 | 22 |
|
18 | 23 | ### Scope |
| 24 | + |
19 | 25 | **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 | 26 |
|
21 | 27 | ### OPTIONAL - Other |
| 28 | + |
22 | 29 | **OPTIONAL -** Feel free to add any other sections or sub-sections that can explain your PR better. |
23 | 30 |
|
24 | 31 | # Testing |
| 32 | + |
25 | 33 | ## Unit testing |
26 | | -**OPTIONAL -** Explain unit tests added, if not clear in the code. |
| 34 | + |
| 35 | +**OPTIONAL -** Explain unit tests added, if not clear in the code. |
27 | 36 |
|
28 | 37 | ## Manual testing |
| 38 | + |
29 | 39 | **RECOMMEND - OPTIONAL -** Explain what scenarios were tested and the environment. |
30 | 40 | 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 | 41 |
|
32 | 42 | # 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 | +- [ ] Notifications |
| 45 | + - [ ] Display |
| 46 | + - [ ] Open |
| 47 | + - [ ] Push Processing |
| 48 | + - [ ] Confirm Deliveries |
| 49 | +- [ ] Outcomes |
| 50 | +- [ ] Sessions |
| 51 | +- [ ] In-App Messaging |
| 52 | +- [ ] REST API requests |
| 53 | +- [ ] Public API changes |
43 | 54 |
|
44 | 55 | # Checklist |
| 56 | + |
45 | 57 | ## 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 |
| 58 | + |
| 59 | +- [ ] I have filled out all **REQUIRED** sections above |
| 60 | +- [ ] PR does one thing |
| 61 | + - 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 |
| 62 | +- [ ] Any Public API changes are explained in the PR details and conform to existing APIs |
50 | 63 |
|
51 | 64 | ## 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 |
| 65 | + |
| 66 | +- [ ] I have included test coverage for these changes, or explained why they are not needed |
| 67 | +- [ ] All automated tests pass, or I explained why that is not possible |
| 68 | +- [ ] I have personally tested this on my device, or explained why that is not possible |
55 | 69 |
|
56 | 70 | ## 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. |
| 71 | + |
| 72 | +- [ ] Code is as readable as possible. |
| 73 | + - Simplify with less code, followed by splitting up code into well named functions and variables, followed by adding comments to the code. |
| 74 | +- [ ] I have reviewed this PR myself, ensuring it meets each checklist item |
| 75 | + - 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