Skip to content

Commit fe7fcdb

Browse files
Martin KonicekFacebook Github Bot 6
authored andcommitted
Update PR and issue guidelines
Reviewed By: mkonicek Differential Revision:D3054017 Ninja: oss only fb-gh-sync-id: df545cb45ae8de3f56f671b06cab84b1f947a01c shipit-source-id: df545cb45ae8de3f56f671b06cab84b1f947a01c
1 parent 6499149 commit fe7fcdb

3 files changed

Lines changed: 23 additions & 12 deletions

File tree

‎PULL_REQUEST_TEMPLATE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ Make sure tests pass on both Travis and Circle CI.
1414

1515
**Code formatting**
1616

17-
See the simple [style guide](https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md#style-guide).
17+
Look around. Match the style of the rest of the codebase. See also the simple [style guide](https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md#style-guide).

‎docs/IssueGuidelines.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
1-
Here are some tips on how to manage GitHub issues efficiently:
1+
## Tips on managing GitHub issues efficiently
22

33
### An issue is a duplicate of another issue
44
Comment e.g. `@facebook-github-bot duplicate #123`. This will add a comment and close the issue.
55
Example: [#5977](https://github.com/facebook/react-native/issues/5977)
66

77
### An issue is a question
8-
StackOverflow is really good for Q&A. It has a reputation system and voting. Questions should absolutely be asked on StackOverflow rather than GitHub. However, to make this work we should hang out on StackOverflow every now and then and answer questions. A nice side effect is you'll get reputation for answering questions there rather than on GitHub.
8+
Questions should absolutely be asked on StackOverflow rather than GitHub.
99
Comment `@facebook-github-bot stack-overflow` to close the issue.
1010
Examples: [#6378](https://github.com/facebook/react-native/issues/6378), [#6015](https://github.com/facebook/react-native/issues/6015), [#6059](https://github.com/facebook/react-native/issues/6059), [#6062](https://github.com/facebook/react-native/issues/6062).
11+
Feel free to also answer some [SO questions](stackoverflow.com/questions/tagged/react-native), you'll get rep :)
1112

1213
### An issue is a question that's been answered
13-
Sometimes and issue has been resolved in the comments. Resolved issues should be closed.
14+
Sometimes and issue has been resolved in the comments.
1415
Comment `@facebook-github-bot answered` to close it.
1516
Example: [#6045](https://github.com/facebook/react-native/issues/6045)
1617

@@ -26,14 +27,15 @@ Comment mentioning the author asking if they plan to provide the additional info
2627
Example: [#6056](https://github.com/facebook/react-native/issues/6056)
2728

2829
### An issue is a valid bug report
29-
Valid bug reports with good repro steps are some of the best issues! Thank the author for finding it, explain that React Native is a community project and ask them if they would be up for sending a fix.
30+
Valid bug reports with good repro steps are some of the best issues! Thank the author for finding it, explain that React Native is a community project and **ask them if they would be up for sending a fix**.
3031

31-
### An issue is a feature request and you're pretty sure React Native should have that feature
32-
Tell the author something like: "Pull requests are welcome. In case you're not up for sending a PR, you should post to [Product Pains](https://productpains.com/product/react-native/?tab=top). It has a voting system and if the feature gets upvoted enough it might get implemented."
33-
34-
### An issue is a feature request for a feature we don't want
32+
### An issue is a feature request. The feature shouldn't be in the code and don't want to maintain it.
3533
This especially includes **new modules** Facebook doesn't use in production. Explain that those modules should be released to npm separately and that everyone will still be able to use the module super easily that way.
3634

35+
### An issue is a feature request, you're pretty sure we should maintain this feature as part of RN
36+
This should be rare - adding a new feature means maintaining it.
37+
Tell the author something like: "Pull requests are welcome. In case you're not up for sending a PR, you should post to [Product Pains](https://productpains.com/product/react-native/?tab=top). It has a voting system and if the feature gets upvoted enough it might get implemented."
38+
3739
### How to add a label
3840
Add any relevant labels, for example 'Android', 'iOS'.
3941
Comment e.g. `@facebook-github-bot label Android`

‎docs/PullRequestGuidelines.md‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
1-
Here are some tips on reviewing pull requests:
1+
## Tips on reviewing pull requests
22

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. Add labels 'Needs revision' and 'Needs response from author'. Examples: [#6395](https://github.com/facebook/react-native/pull/6395), [#5637](https://github.com/facebook/react-native/pull/5637).
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 codebase? If not, link to the style guide and add the label 'Needs revision'.
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. Add labels 'Needs revision' and 'Needs response from author'. Examples: [#6395](https://github.com/facebook/react-native/pull/6395).
4+
Example:
5+
6+
> Hey @author, thanks for sending the pull request.
7+
> Can you please add all the info specified in the [template](https://github.com/facebook/react-native/blob/master/PULL_REQUEST_TEMPLATE.md)? This is necessary for people to be able to understand and review your pull request.
8+
9+
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 codebase? If not, link to the style guide and add the label 'Needs revision'.
10+
11+
Does the pull request add a completely new feature we don't want to add to the core and maintain? Ask the author to release it a separate npm module.
12+
13+
Does the pull request do several unrelated things at the same time? Ask the author to split it.

0 commit comments

Comments
 (0)