Skip to content

Commit 9ae645d

Browse files
authored
chore: update PR template with new requirements (#3519)
## Description Update PR template. First and foremost - the "Before & after - visual documentation" section is now mandatory for any PR that introduces visual changes / changes in behaviour. Moreover, a requirement for creating / keeping test-local changelog is introduced. It is now mandatory to write a short description / link a PR in the comment in the top of the test file to indicate what it tests. Beside above, I've cleaned up the template from outdated parts & improved the wording. Closes software-mansion/react-native-screens-labs#741
1 parent 82e5c5f commit 9ae645d

File tree

1 file changed

+30
-19
lines changed

1 file changed

+30
-19
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,63 @@
11
## Description
22

33
<!--
4-
Description and motivation for this PR.
4+
Description and motivation for this PR.
5+
This section should include "what & why".
56
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.
79
8-
Fixes # .
10+
For example:
11+
Closes #12345.
912
-->
1013

1114
## Changes
1215

1316
<!--
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.
1521
1622
For example:
1723
1824
- Updated `about.md` docs
19-
2025
-->
2126

27+
## Before & after - visual documentation
28+
2229
<!--
30+
This section is MANDATORY for any PR that introduces any visual changes.
2331
24-
## Screenshots / GIFs
32+
If your PR does not introduce such changes, please omit this section.
2533
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.
2736
28-
You can add before / after section if you're changing some behavior.
37+
| Before | After |
38+
| --- | --- |
39+
| ![Before](before.png) | ![After](after.png) |
40+
41+
Alternatively add two sections - Before & After
2942
3043
### Before
3144
3245
### After
33-
3446
-->
3547

36-
## Test code and steps to reproduce
48+
## Test plan
3749

3850
<!--
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.
4155
-->
4256

4357
## Checklist
4458

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.
5263
- [ ] Ensured that CI passes

0 commit comments

Comments
 (0)