status-im
/
react-native
mirror of https://github.com/status-im/react-native.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
react-native/.github/PULL_REQUEST_TEMPLATE.md

33 lines
1.4 KiB
Markdown
Raw Normal View History

Shorten template instructions. Summary: I've noticed many pull requests are opened with a very short description that fails to explain the motivation behind the PR, and many more forego providing a test plan. With this PR, I am shortening the template in order to provide concise instructions that provide the essential steps above the fold in the "Open a pull request" composer window. - We need people to open a PR against master, not stable. The exact reason for this is not important and providing an explanation takes away from other more important points. - Test plans are essential, but their requirement appears below the fold in the current template. - More PRs could use tests. - Make a point of asking PR authors to follow up on CI test failures. - The composer does not parse Markdown into HTML. Markdown is pretty readable as is, but using reference links instead of inline links should help with readability. I observed that it will only display the first 8 lines of the PR template above the fold. Seeing t Closes https://github.com/facebook/react-native/pull/12958 Differential Revision: D4718294 Pulled By: mkonicek fbshipit-source-id: b19a29e5ed73fb78d09c7de17625b1883590075c
2017-03-16 00:24:39 +00:00
Thanks for submitting a PR! Please read these instructions carefully:
Update PR and issue templates and guidelines Summary:- Simplified the PR and Issue template to make them easier to read. - Add a very simple guide for reviewing PRs (cc bestander, feel free to add to this) Closes https://github.com/facebook/react-native/pull/6295 Differential Revision: D3011905 fb-gh-sync-id: 4929921690a6996e574e6b152a9dd41087cfffdc shipit-source-id: 4929921690a6996e574e6b152a9dd41087cfffdc
2016-03-04 17:14:32 +00:00
Shorten template instructions. Summary: I've noticed many pull requests are opened with a very short description that fails to explain the motivation behind the PR, and many more forego providing a test plan. With this PR, I am shortening the template in order to provide concise instructions that provide the essential steps above the fold in the "Open a pull request" composer window. - We need people to open a PR against master, not stable. The exact reason for this is not important and providing an explanation takes away from other more important points. - Test plans are essential, but their requirement appears below the fold in the current template. - More PRs could use tests. - Make a point of asking PR authors to follow up on CI test failures. - The composer does not parse Markdown into HTML. Markdown is pretty readable as is, but using reference links instead of inline links should help with readability. I observed that it will only display the first 8 lines of the PR template above the fold. Seeing t Closes https://github.com/facebook/react-native/pull/12958 Differential Revision: D4718294 Pulled By: mkonicek fbshipit-source-id: b19a29e5ed73fb78d09c7de17625b1883590075c
2017-03-16 00:24:39 +00:00
- [ ] Explain the **motivation** for making this change.
- [ ] Provide a **test plan** demonstrating that the code is solid.
- [ ] Match the **code formatting** of the rest of the codebase.
- [ ] Target the `master` branch, NOT a "stable" branch.
Pull requests should target master branch Summary: Make it more obvious that pull requests should generally target the `master` branch. Provide visible clarity in both the `CONTRIBUTING.md` and the actual pull request template. Closes https://github.com/facebook/react-native/pull/8748 Differential Revision: D3566827 fbshipit-source-id: 6326f18b93594e928b1c4e0d09a739a8ccedaa62
2016-07-15 02:00:29 +00:00
Shorten template instructions. Summary: I've noticed many pull requests are opened with a very short description that fails to explain the motivation behind the PR, and many more forego providing a test plan. With this PR, I am shortening the template in order to provide concise instructions that provide the essential steps above the fold in the "Open a pull request" composer window. - We need people to open a PR against master, not stable. The exact reason for this is not important and providing an explanation takes away from other more important points. - Test plans are essential, but their requirement appears below the fold in the current template. - More PRs could use tests. - Make a point of asking PR authors to follow up on CI test failures. - The composer does not parse Markdown into HTML. Markdown is pretty readable as is, but using reference links instead of inline links should help with readability. I observed that it will only display the first 8 lines of the PR template above the fold. Seeing t Closes https://github.com/facebook/react-native/pull/12958 Differential Revision: D4718294 Pulled By: mkonicek fbshipit-source-id: b19a29e5ed73fb78d09c7de17625b1883590075c
2017-03-16 00:24:39 +00:00
## Motivation (required)
PR and Issue templates Reviewed By: mkonicek Differential Revision:D2946749 Ninja: GitHub-only fb-gh-sync-id: ac8a316ca4c2982a063040d57ddc1f279b81b59d shipit-source-id: ac8a316ca4c2982a063040d57ddc1f279b81b59d
2016-02-17 23:57:27 +00:00
Shorten template instructions. Summary: I've noticed many pull requests are opened with a very short description that fails to explain the motivation behind the PR, and many more forego providing a test plan. With this PR, I am shortening the template in order to provide concise instructions that provide the essential steps above the fold in the "Open a pull request" composer window. - We need people to open a PR against master, not stable. The exact reason for this is not important and providing an explanation takes away from other more important points. - Test plans are essential, but their requirement appears below the fold in the current template. - More PRs could use tests. - Make a point of asking PR authors to follow up on CI test failures. - The composer does not parse Markdown into HTML. Markdown is pretty readable as is, but using reference links instead of inline links should help with readability. I observed that it will only display the first 8 lines of the PR template above the fold. Seeing t Closes https://github.com/facebook/react-native/pull/12958 Differential Revision: D4718294 Pulled By: mkonicek fbshipit-source-id: b19a29e5ed73fb78d09c7de17625b1883590075c
2017-03-16 00:24:39 +00:00
What existing problem does the pull request solve?
PR and Issue templates Reviewed By: mkonicek Differential Revision:D2946749 Ninja: GitHub-only fb-gh-sync-id: ac8a316ca4c2982a063040d57ddc1f279b81b59d shipit-source-id: ac8a316ca4c2982a063040d57ddc1f279b81b59d
2016-02-17 23:57:27 +00:00
Shorten template instructions. Summary: I've noticed many pull requests are opened with a very short description that fails to explain the motivation behind the PR, and many more forego providing a test plan. With this PR, I am shortening the template in order to provide concise instructions that provide the essential steps above the fold in the "Open a pull request" composer window. - We need people to open a PR against master, not stable. The exact reason for this is not important and providing an explanation takes away from other more important points. - Test plans are essential, but their requirement appears below the fold in the current template. - More PRs could use tests. - Make a point of asking PR authors to follow up on CI test failures. - The composer does not parse Markdown into HTML. Markdown is pretty readable as is, but using reference links instead of inline links should help with readability. I observed that it will only display the first 8 lines of the PR template above the fold. Seeing t Closes https://github.com/facebook/react-native/pull/12958 Differential Revision: D4718294 Pulled By: mkonicek fbshipit-source-id: b19a29e5ed73fb78d09c7de17625b1883590075c
2017-03-16 00:24:39 +00:00
## Test Plan (required)
PR and Issue templates Reviewed By: mkonicek Differential Revision:D2946749 Ninja: GitHub-only fb-gh-sync-id: ac8a316ca4c2982a063040d57ddc1f279b81b59d shipit-source-id: ac8a316ca4c2982a063040d57ddc1f279b81b59d
2016-02-17 23:57:27 +00:00
Shorten template instructions. Summary: I've noticed many pull requests are opened with a very short description that fails to explain the motivation behind the PR, and many more forego providing a test plan. With this PR, I am shortening the template in order to provide concise instructions that provide the essential steps above the fold in the "Open a pull request" composer window. - We need people to open a PR against master, not stable. The exact reason for this is not important and providing an explanation takes away from other more important points. - Test plans are essential, but their requirement appears below the fold in the current template. - More PRs could use tests. - Make a point of asking PR authors to follow up on CI test failures. - The composer does not parse Markdown into HTML. Markdown is pretty readable as is, but using reference links instead of inline links should help with readability. I observed that it will only display the first 8 lines of the PR template above the fold. Seeing t Closes https://github.com/facebook/react-native/pull/12958 Differential Revision: D4718294 Pulled By: mkonicek fbshipit-source-id: b19a29e5ed73fb78d09c7de17625b1883590075c
2017-03-16 00:24:39 +00:00
A good test plan has the exact commands you ran and their output, provides screenshots or videos if the pull request changes UI or updates the website. See [What is a Test Plan?][1] to learn more.
PR and Issue templates Reviewed By: mkonicek Differential Revision:D2946749 Ninja: GitHub-only fb-gh-sync-id: ac8a316ca4c2982a063040d57ddc1f279b81b59d shipit-source-id: ac8a316ca4c2982a063040d57ddc1f279b81b59d
2016-02-17 23:57:27 +00:00
Shorten template instructions. Summary: I've noticed many pull requests are opened with a very short description that fails to explain the motivation behind the PR, and many more forego providing a test plan. With this PR, I am shortening the template in order to provide concise instructions that provide the essential steps above the fold in the "Open a pull request" composer window. - We need people to open a PR against master, not stable. The exact reason for this is not important and providing an explanation takes away from other more important points. - Test plans are essential, but their requirement appears below the fold in the current template. - More PRs could use tests. - Make a point of asking PR authors to follow up on CI test failures. - The composer does not parse Markdown into HTML. Markdown is pretty readable as is, but using reference links instead of inline links should help with readability. I observed that it will only display the first 8 lines of the PR template above the fold. Seeing t Closes https://github.com/facebook/react-native/pull/12958 Differential Revision: D4718294 Pulled By: mkonicek fbshipit-source-id: b19a29e5ed73fb78d09c7de17625b1883590075c
2017-03-16 00:24:39 +00:00
If you have added code that should be tested, add tests.
PR and Issue templates Reviewed By: mkonicek Differential Revision:D2946749 Ninja: GitHub-only fb-gh-sync-id: ac8a316ca4c2982a063040d57ddc1f279b81b59d shipit-source-id: ac8a316ca4c2982a063040d57ddc1f279b81b59d
2016-02-17 23:57:27 +00:00
Shorten template instructions. Summary: I've noticed many pull requests are opened with a very short description that fails to explain the motivation behind the PR, and many more forego providing a test plan. With this PR, I am shortening the template in order to provide concise instructions that provide the essential steps above the fold in the "Open a pull request" composer window. - We need people to open a PR against master, not stable. The exact reason for this is not important and providing an explanation takes away from other more important points. - Test plans are essential, but their requirement appears below the fold in the current template. - More PRs could use tests. - Make a point of asking PR authors to follow up on CI test failures. - The composer does not parse Markdown into HTML. Markdown is pretty readable as is, but using reference links instead of inline links should help with readability. I observed that it will only display the first 8 lines of the PR template above the fold. Seeing t Closes https://github.com/facebook/react-native/pull/12958 Differential Revision: D4718294 Pulled By: mkonicek fbshipit-source-id: b19a29e5ed73fb78d09c7de17625b1883590075c
2017-03-16 00:24:39 +00:00
## Next Steps
PR and Issue templates Reviewed By: mkonicek Differential Revision:D2946749 Ninja: GitHub-only fb-gh-sync-id: ac8a316ca4c2982a063040d57ddc1f279b81b59d shipit-source-id: ac8a316ca4c2982a063040d57ddc1f279b81b59d
2016-02-17 23:57:27 +00:00
Shorten template instructions. Summary: I've noticed many pull requests are opened with a very short description that fails to explain the motivation behind the PR, and many more forego providing a test plan. With this PR, I am shortening the template in order to provide concise instructions that provide the essential steps above the fold in the "Open a pull request" composer window. - We need people to open a PR against master, not stable. The exact reason for this is not important and providing an explanation takes away from other more important points. - Test plans are essential, but their requirement appears below the fold in the current template. - More PRs could use tests. - Make a point of asking PR authors to follow up on CI test failures. - The composer does not parse Markdown into HTML. Markdown is pretty readable as is, but using reference links instead of inline links should help with readability. I observed that it will only display the first 8 lines of the PR template above the fold. Seeing t Closes https://github.com/facebook/react-native/pull/12958 Differential Revision: D4718294 Pulled By: mkonicek fbshipit-source-id: b19a29e5ed73fb78d09c7de17625b1883590075c
2017-03-16 00:24:39 +00:00
Sign the [CLA][2], if you haven't already.
Update the PR template Summary: Added a link to the contributing.md -- there's a bunch of stuff there that's not mentioned in this template. Closes https://github.com/facebook/react-native/pull/6899 Differential Revision: D3245105 fb-gh-sync-id: 4d462dded04cf83afdd9b6dddcbc45aa7ecd7cd9 fbshipit-source-id: 4d462dded04cf83afdd9b6dddcbc45aa7ecd7cd9
2016-04-30 04:14:59 +00:00
Shorten template instructions. Summary: I've noticed many pull requests are opened with a very short description that fails to explain the motivation behind the PR, and many more forego providing a test plan. With this PR, I am shortening the template in order to provide concise instructions that provide the essential steps above the fold in the "Open a pull request" composer window. - We need people to open a PR against master, not stable. The exact reason for this is not important and providing an explanation takes away from other more important points. - Test plans are essential, but their requirement appears below the fold in the current template. - More PRs could use tests. - Make a point of asking PR authors to follow up on CI test failures. - The composer does not parse Markdown into HTML. Markdown is pretty readable as is, but using reference links instead of inline links should help with readability. I observed that it will only display the first 8 lines of the PR template above the fold. Seeing t Closes https://github.com/facebook/react-native/pull/12958 Differential Revision: D4718294 Pulled By: mkonicek fbshipit-source-id: b19a29e5ed73fb78d09c7de17625b1883590075c
2017-03-16 00:24:39 +00:00
Small pull requests are much easier to review and more likely to get merged. Make sure the PR does only one thing, otherwise please split it.
Make sure all **tests pass** on both [Travis][3] and [Circle CI][4]. PRs that break tests are unlikely to be merged.
For more info, see the ["Pull Requests"][5] section of our "Contributing" guidelines.
[1]: https://medium.com/@martinkonicek/what-is-a-test-plan-8bfc840ec171#.y9lcuqqi9
[2]: https://code.facebook.com/cla
[3]: https://travis-ci.org/facebook/react-native
[4]: http://circleci.com/gh/facebook/react-native
[5]: https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md#pull-requests