|
1 | 1 | ## Description |
2 | 2 |
|
3 | 3 | <!-- |
4 | | -Description and motivation for this PR. |
| 4 | +Description and motivation for this PR. |
| 5 | +This section should include "what & why". |
5 | 6 |
|
6 | | -Include Fixes #<number> if this is fixing some issue. |
| 7 | +Please link all related issues that merging this PR should close, |
| 8 | +by using the `Closes #<issue-number>` syntax. |
7 | 9 |
|
8 | | -Fixes # . |
| 10 | +For example: |
| 11 | +Closes #12345. |
9 | 12 | --> |
10 | 13 |
|
11 | 14 | ## Changes |
12 | 15 |
|
13 | 16 | <!-- |
14 | | -Please describe things you've changed here, make a **high level** overview, if change is simple you can omit this section. |
| 17 | +This is "how" of the PR description. |
| 18 | +
|
| 19 | +Please describe things you've changed here, make a **high level** overview, |
| 20 | +if change is simple you can omit this section. |
15 | 21 |
|
16 | 22 | For example: |
17 | 23 |
|
18 | 24 | - Updated `about.md` docs |
19 | | -
|
20 | 25 | --> |
21 | 26 |
|
| 27 | +## Before & after - visual documentation |
| 28 | + |
22 | 29 | <!-- |
| 30 | +This section is MANDATORY for any PR that introduces any visual changes. |
23 | 31 |
|
24 | | -## Screenshots / GIFs |
| 32 | +If your PR does not introduce such changes, please omit this section. |
25 | 33 |
|
26 | | -Here you can add screenshots / GIFs documenting your change. |
| 34 | +Consider using a table here to position the recordings / screenshots |
| 35 | +next to each other. |
27 | 36 |
|
28 | | -You can add before / after section if you're changing some behavior. |
| 37 | +| Before | After | |
| 38 | +| --- | --- | |
| 39 | +|  |  | |
| 40 | +
|
| 41 | +Alternatively add two sections - Before & After |
29 | 42 |
|
30 | 43 | ### Before |
31 | 44 |
|
32 | 45 | ### After |
33 | | -
|
34 | 46 | --> |
35 | 47 |
|
36 | | -## Test code and steps to reproduce |
| 48 | +## Test plan |
37 | 49 |
|
38 | 50 | <!-- |
39 | | -Please include code that can be used to test this change and short description how this example should work. |
40 | | -This snippet should be as minimal as possible and ready to be pasted into editor (don't exclude exports or remove "not important" parts of reproduction example) |
| 51 | +Please name all newly added and existing test files that you tested the changes with. |
| 52 | +This section should also contain short description of steps to reproduce the issue. |
| 53 | +
|
| 54 | +The reproduction code should be minimal & complete. Don't exclude exports or remove "not important" parts of reproduction example. |
41 | 55 | --> |
42 | 56 |
|
43 | 57 | ## Checklist |
44 | 58 |
|
45 | | -- [ ] Included code example that can be used to test this change |
46 | | -- [ ] Updated TS types |
47 | | -- [ ] Updated documentation: <!-- For adding new props to native-stack --> |
48 | | - - [ ] https://github.com/software-mansion/react-native-screens/blob/main/guides/GUIDE_FOR_LIBRARY_AUTHORS.md |
49 | | - - [ ] https://github.com/software-mansion/react-native-screens/blob/main/native-stack/README.md |
50 | | - - [ ] https://github.com/software-mansion/react-native-screens/blob/main/src/types.tsx |
51 | | - - [ ] https://github.com/software-mansion/react-native-screens/blob/main/src/native-stack/types.tsx |
| 59 | +- [ ] Included code example that can be used to test this change. |
| 60 | +- [ ] Updated / created local changelog entries in relevant test files. |
| 61 | +- [ ] For visual changes, included screenshots / GIFs / recordings documenting the change. |
| 62 | +- [ ] For API changes, updated relevant public types. |
52 | 63 | - [ ] Ensured that CI passes |
0 commit comments