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

19 lines
774 B
Markdown
Raw Normal View History

Update guidelines. Summary: Consolidate tips on CONTRIBUTING.md, and reduce the wall of text when opening a new issue. Hoping this will encourage more people to read through the text. Closes https://github.com/facebook/react-native/pull/14518 Differential Revision: D5250443 Pulled By: hramos fbshipit-source-id: 91213c4ceca12225d9f54d1e1e81e020c6e463b3
2017-06-14 22:08:46 +00:00
<details>
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
Update guidelines. Summary: Consolidate tips on CONTRIBUTING.md, and reduce the wall of text when opening a new issue. Hoping this will encourage more people to read through the text. Closes https://github.com/facebook/react-native/pull/14518 Differential Revision: D5250443 Pulled By: hramos fbshipit-source-id: 91213c4ceca12225d9f54d1e1e81e020c6e463b3
2017-06-14 22:08:46 +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.
Please read the [Contribution Guidelines](https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md) to learn more about contributing to React Native.
</details>
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
Update guidelines. Summary: Consolidate tips on CONTRIBUTING.md, and reduce the wall of text when opening a new issue. Hoping this will encourage more people to read through the text. Closes https://github.com/facebook/react-native/pull/14518 Differential Revision: D5250443 Pulled By: hramos fbshipit-source-id: 91213c4ceca12225d9f54d1e1e81e020c6e463b3
2017-06-14 22:08:46 +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
Update guidelines. Summary: Consolidate tips on CONTRIBUTING.md, and reduce the wall of text when opening a new issue. Hoping this will encourage more people to read through the text. Closes https://github.com/facebook/react-native/pull/14518 Differential Revision: D5250443 Pulled By: hramos fbshipit-source-id: 91213c4ceca12225d9f54d1e1e81e020c6e463b3
2017-06-14 22:08:46 +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._