You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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)
Closesfacebook/react-native#6295
Differential Revision: D3011905
fb-gh-sync-id: 4929921690a6996e574e6b152a9dd41087cfffdc
shipit-source-id: 4929921690a6996e574e6b152a9dd41087cfffdc
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,6 +73,7 @@ Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
73
73
74
74
#### General
75
75
76
+
***Most important: Look around.** Match the style you see used in the rest of the project. This includes formatting, naming things in code, naming things in documentation.
Copy file name to clipboardExpand all lines: ISSUE_TEMPLATE.md
+11-21Lines changed: 11 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,30 +2,20 @@ Hey there and thank you for using React Native!
2
2
3
3
React Native, as you've probably heard, is getting really popular and truth is we're getting a bit overwhelmed by the activity surrounding it. There are just too many issues for us to manage properly.
4
4
5
-
Please read the following tips before filing an issue:
-[ ] Is this something you can **debug and fix**? Send a pull request! Bug fixes and documentation fixes are welcome.
8
+
-[ ] Have a usage question? Ask your question on [StackOverflow](http://stackoverflow.com/questions/tagged/react-native). We use StackOverflow for usage question and GitHub for bugs.
9
+
-[ ] Have an idea for a feature? Post the feature request on [Product Pains](https://productpains.com/product/react-native/). It has a voting system to surface the important issues. GitHub issues should only be used for bugs.
9
10
10
-
Can you see anything in the logs? Can you debug why this happens? **Send a pull request**! Bug fixes and documentation fixes are very welcome.
Please ask your question on [StackOverflow](http://stackoverflow.com/questions/tagged/react-native) with the tag `react-native`. StackOverflow is amazing for Q&A. Because of the reputation system it is likely the community will see and answer your question there.
15
-
16
-
Make sure you **include a short code snippet to demonstrate the problem**.
17
-
18
-
Have an idea for a feature?
19
-
------------------------------------
20
-
Post the feature request on [Product Pains](https://productpains.com/product/react-native/). It has a voting system that lets us focus on the most important issues the community is experiencing. The higher number of votes the more likely it is a feature will get implemented. You could always implement it yourself, too.
Make sure to add **all the information needed to understand the issue** so that someone can help. If the info is missing we'll add the 'Needs more information' label and close the issue until there is enough information.
15
+
Make sure to add **all the information needed to understand the bug** so that someone can help. If the info is missing we'll add the 'Needs more information' label and close the issue until there is enough information.
26
16
27
-
-If this is a bug, provide a **minimal code snippet** that reproduces it
28
-
- Provide **screenshots** where appropriate
29
-
- What's the **version** of React Native you're using?
30
-
- Does this occur on iOS, Android or both?
31
-
- Are you using Mac, Linux or Windows?
17
+
-[ ] Provide a **minimal code snippet**/ [rnplay](https://rnplay.org/) example that reproduces the bug.
18
+
-[ ]Provide **screenshots** where appropriate
19
+
-[ ]What's the **version** of React Native you're using?
Copy file name to clipboardExpand all lines: PULL_REQUEST_TEMPLATE.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,16 @@
1
-
Hey there and thanks for submitting a pull request! Please have a look at the following checklist so that others have enough information to review your pull request:
1
+
Thanks for submitting a pull request! Please provide enough information so that others can review your pull request:
2
+
3
+
(You can skip this if you're fixing a typo or adding an app to the Showcase.)
2
4
3
5
Explain the **motivation** for making this change. What existing problem does the pull request solve?
4
6
5
-
Example: When saying "Add a function to do X", explain why it is necessary to have a way to do X.
7
+
Example: When "Adding a function to do X", explain why it is necessary to have a way to do X.
6
8
7
9
**Test plan (required)**
8
10
9
-
Describe exact steps you've done to test that the code works. This means exact commands you ran, screenshots / videos if the pull request changes UI.
11
+
Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.
10
12
11
-
Make sure tests pass on Circle CI.
13
+
Make sure tests pass on both Travis and Circle CI.
Here are some tips on how you can help review pull requests:
2
+
3
+
- Does the PR miss info required in the [Pull request template](https://github.com/facebook/react-native/blob/master/PULL_REQUEST_TEMPLATE.md)? Ask for it and link to the template.
4
+
- Does the code style match the [Style guide](https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md#style-guide), especially consistency with the rest of the code? If not, link to the style guide.
0 commit comments