mirror of
https://github.com/status-im/react-native.git
synced 2025-01-09 09:12:02 +00:00
28bb1960a4
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
33 lines
1.4 KiB
Markdown
33 lines
1.4 KiB
Markdown
Thanks for submitting a PR! Please read these instructions carefully:
|
|
|
|
- [ ] 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.
|
|
|
|
## Motivation (required)
|
|
|
|
What existing problem does the pull request solve?
|
|
|
|
## Test Plan (required)
|
|
|
|
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.
|
|
|
|
If you have added code that should be tested, add tests.
|
|
|
|
## Next Steps
|
|
|
|
Sign the [CLA][2], if you haven't already.
|
|
|
|
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
|