Skip to content

Commit d41957d

Browse files
committed
How to Contribute updates
Summary: Rename "Testing" guide. Add docs for several new GitHub bot commands. Format commands table. Built website and verified everything looks good. Closes facebook#15111 Differential Revision: D5458660 Pulled By: hramos fbshipit-source-id: 151ea0cbd18489bc527193682464ca291d6ab467
1 parent d4e6bcd commit d41957d

5 files changed

Lines changed: 330 additions & 99 deletions

File tree

.github/ISSUE_TEMPLATE.md

Lines changed: 106 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,124 @@
1-
Please read the following carefully. Issues that do not follow these guidelines will be closed.
1+
<!--
2+
PLEASE DON'T DELETE THIS TEMPLATE UNTIL YOU HAVE READ THE FIRST SECTION.
3+
-->
24

3-
We use GitHub Issues exclusively for tracking bugs in React Native.
5+
### Is this a bug report?
46

5-
- Have a question? Ask on Stack Overflow: http://stackoverflow.com/questions/tagged/react-native
6-
- Have a feature request? Submit it here: https://react-native.canny.io/feature-requests
7-
- Want to know more about future plans? Check out the roadmap: https://github.com/facebook/react-native/wiki/Roadmap
7+
(write your answer here)
88

9-
## Reporting Bugs
9+
<!--
10+
If you answered "Yes":
1011
11-
Report a single bug per issue.
12+
We expect that it will take you about 30 minutes to produce a high-quality bug report.
13+
While this may seem like a lot, putting care into issues helps us fix them faster.
14+
For bug reports, it is REQUIRED to fill the rest of this template, or the issue will be closed.
1215
13-
### Reproducing bugs
16+
If you answered "No":
1417
15-
- Always provide reproduction steps.
16-
- Use Snack. Try to reproduce your bug on https://snack.expo.io/ first of all.
17-
If the bug cannot be reproduced using Snack, verify that the issue can be reproduced locally by targeting the latest release candidate. Ideally, check if the issue is present in master as well.
18-
- Do not forget to include sample code that reproduces the issue.
18+
We use GitHub Issues exclusively for tracking bugs in React Native. If you're looking for help,
19+
check out the How to Get In Touch section of the following guide:
20+
https://facebook.github.io/react-native/docs/contributing.html#how-to-get-in-touch
1921
20-
Issues that do not describe a bug or do not follow the template will be closed.
22+
Now scroll below!
23+
-->
2124

22-
--- Delete everything above this line ---
2325

24-
### Description
26+
### Have you read the Bugs section of the How to Contribute guide?
2527

26-
Explain what you did, what you expected to happen, and what actually happens.
28+
(Write your answer here.)
2729

28-
### Reproduction Steps and Sample Code
30+
<!--
31+
Please read through the bug reporting guidelines thoroughly:
32+
https://facebook.github.io/react-native/docs/contributing.html#bugs
33+
-->
2934

30-
List all the steps required to reproduce the issue you're reporting. These steps should be clear and concise.
35+
### Environment
3136

32-
***An example of your code or a repro using Snack is REQUIRED***
37+
<!--
38+
Please fill in all the relevant fields by running these commands in terminal.
39+
-->
3340

41+
1. `react-native -v`:
42+
2. `node -v`:
43+
3. `npm -v`:
44+
4. `yarn --version`<!-- (if you use Yarn) -->:
3445

35-
### Solution
46+
Then, specify:
3647

37-
What needs to be done to address this issue? Ideally, provide a pull request with a fix.
48+
<!-- (What platform are you building for? Choose any from iOS, Android, AppleTV.) -->
49+
- Target Platform:
3850

39-
### Additional Information
51+
<!-- Which operating system are you using? Specify macOS, Windows, or Linux, along with specific release versions -->
52+
- Development Operating System:
4053

41-
* React Native version: [FILL THIS OUT: Be specific, filling out "latest" here is not enough.]
42-
* Platform: [FILL THIS OUT: iOS, Android, or both?]
43-
* Development Operating System: [FILL THIS OUT: Are you developing on macOS, Linux, or Windows?]
44-
* Dev tools: [FILL THIS OUT: Xcode or Android Studio version, iOS or Android SDK version, if applicable]
54+
<!-- Include any additional relevant information. Are you using Xcode or Android Studio to build native code? Is the issue specific to a particular iOS or Android SDK? -->
55+
- Build tools:
56+
57+
### Steps to Reproduce
58+
59+
<!--
60+
How would you describe your issue to someone who doesn’t know you or your project?
61+
Try to write a sequence of steps that anybody can repeat to see the issue.
62+
Be specific! If the bug cannot be reproduced, your issue may be closed.
63+
-->
64+
65+
(Write your steps here:)
66+
67+
1.
68+
2.
69+
3.
70+
71+
### Expected Behavior
72+
73+
<!--
74+
How did you expect your project to behave?
75+
It’s fine if you’re not sure your understanding is correct.
76+
Just write down what you thought would happen.
77+
-->
78+
79+
(Write what you thought would happen.)
80+
81+
### Actual Behavior
82+
83+
<!--
84+
Did something go wrong?
85+
Is something broken, or not behaving as you expected?
86+
Describe this section in detail, and attach screenshots if possible.
87+
Don't just say "it doesn't work"!
88+
-->
89+
90+
(Write what happened. Add screenshots!)
91+
92+
### Reproducible Demo
93+
94+
<!--
95+
Please share a project that reproduces the issue.
96+
There are two ways to do it:
97+
98+
* Create a new app using https://snack.expo.io/ and try to reproduce the issue in it.
99+
This is useful if you roughly know where the problem is, or can’t share the real code.
100+
101+
* Or, copy your app and remove things until you’re left with the minimal reproducible demo.
102+
This is useful for finding the root cause. You may then optionally create a Snack.
103+
104+
This is a good guide to creating bug demos: https://stackoverflow.com/help/mcve
105+
Once you’re done, copy and paste the link to the Snack or a public GitHub repository below:
106+
-->
107+
108+
(Paste the link to an example project and exact instructions to reproduce the issue.)
109+
110+
<!--
111+
What happens if you skip this step?
112+
113+
Someone will read your bug report, and maybe will be able to help you,
114+
but it’s unlikely that it will get much attention from the team. Eventually,
115+
the issue will likely get closed in favor of issues that have reproducible demos.
116+
117+
Please remember that:
118+
119+
* Issues without reproducible demos have a very low priority.
120+
* The person fixing the bug would have to do that anyway. Please be respectful of their time.
121+
* You might figure out the issues yourself as you work on extracting it.
122+
123+
Thanks for helping us help you!
124+
-->

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,11 @@ Facebook has adopted a Code of Conduct that we expect project participants to ad
5555

5656
### Contributing Guide
5757

58-
Read our [contributing guide](CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to React Native.
58+
Read our [contributing guide](https://facebook.github.io/react-native/docs/contributing.html) to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes to React Native.
5959

6060
### Beginner Friendly Bugs
6161

62-
We have a list of [beginner friendly bugs](https://github.com/facebook/react-native/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+First+Task%22) to help you get your feet wet in the React Native codebase and familiar with our contribution process. This is a great place to get started.
63-
62+
We have a list of [beginner friendly issues](https://github.com/facebook/react-native/labels/Good%20First%20Task) to help you get your feet wet in the React Native codebase and familiar with our contribution process. This is a great place to get started.
6463

6564
## License
6665

bots/IssueCommands.txt

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,64 @@
1-
React Native GitHub Issue Task Force: AndrewJack, astreet, bestander, brentvatne, browniefed, cancan101, charpeni, chirag04, christopherdro, corbt, cosmith, damusnet, DanielMSchmidt, davidaurelio, dmmiller, dsibiski, foghina, frantic, geirman, grabbou, gre, ide, janicduplessis, javache, jaygarcia, jsierles, kmagiera, knowbody, kmagiera, Kureev, lelandrichardson, martinbigio, melihmucuk, mkonicek, ncuillery, rmevans9, rt2zz, ryankask, satya164, skevy, vjeux
1+
React Native GitHub Issue Task Force: AndrewJack, astreet, bestander, brentvatne, browniefed, cancan101, charpeni, chirag04, christopherdro, corbt, cosmith, damusnet, DanielMSchmidt, davidaurelio, dmmiller, dsibiski, foghina, frantic, gantman, geirman, grabbou, gre, ide, janicduplessis, javache, jaygarcia, jsierles, kmagiera, knowbody, kmagiera, Kureev, lelandrichardson, martinbigio, melihmucuk, mkonicek, ncuillery, rmevans9, rt2zz, ryankask, satya164, skevy, tabrindle, vjeux
22

33
@facebook-github-bot answered
4-
comment Closing this issue as {author} says the question asked has been answered. Please help us by asking questions on [StackOverflow](http://stackoverflow.com/questions/tagged/react-native). StackOverflow is amazing for Q&A: it has a reputation system, voting, the ability to mark a question as answered. Because of the reputation system it is likely the community will see and answer your question there. This also helps us use the GitHub bug tracker for bugs only.
4+
comment Closing this issue as {author} says the question asked has been answered.
55
close
66

77
@facebook-github-bot duplicate (#[0-9]+)
8-
comment {author} tells me this issue is a duplicate of {match0}. Let's discuss there, closing this one.
8+
comment Duplicate of {match0}
99
close
1010

1111
@facebook-github-bot expected
12-
comment The comment above tells me this is expected behavior. Closing this as we'd like to use the GitHub issue tracker for bugs. If you'd like to change how this feature works please post a feature request on [Canny](https://react-native.canny.io/feature-requests) so that other people can vote on it.
12+
comment The comment above tells me this is expected behavior. If you'd like to change how this feature works, please submit a feature request on [Canny](https://react-native.canny.io/feature-requests) so that other people can vote on it.
1313
close
1414

1515
@facebook-github-bot stack-overflow
16-
comment Hey {issue_author} and thanks for posting this! {author} tells me this issue looks like a question that would be best asked on [StackOverflow](http://stackoverflow.com/questions/tagged/react-native). StackOverflow is amazing for Q&A: it has a reputation system, voting, the ability to mark a question as answered. Because of the reputation system it is likely the community will see and answer your question there. This also helps us use the GitHub bug tracker for bugs only. Will close this as this is really a question that should be asked on SO.
16+
comment Hey {issue_author}, thanks for posting this! {author} tells me this issue looks like a question that would be best asked on [Stack Overflow](http://stackoverflow.com/questions/tagged/react-native). Stack Overflow is amazing for Q&A: it has a reputation system, voting, the ability to mark a question as answered. Because of the reputation system it is likely the community will see and answer your question there. This also helps us use the GitHub bug tracker for bugs only.
1717
add-label For Stack Overflow
1818
close
1919

2020
@facebook-github-bot label (.*)
2121
add-label {match0}
2222

2323
@facebook-github-bot no-reply
24-
comment Closing this issue as more information is needed to debug this and we haven't heard back from the author. Once there's more information we can reopen the issue.
24+
comment Closing this issue as more information is needed to debug this and we haven't heard back from the author.
25+
add-label Needs Response from Author
26+
close
27+
28+
@facebook-github-bot no-template
29+
comment Hey, thanks for reporting this issue! It looks like your description is missing some necessary information, or the list of reproduction steps is not complete. Can you please add all the details specified in the [Issue Template](https://raw.githubusercontent.com/facebook/react-native/master/.github/ISSUE_TEMPLATE.md)? This is necessary for people to be able to understand and reproduce the issue being reported. I am going to close this, but feel free to open a new issue with the additional information provided. Thanks!
30+
add-label Needs more information
2531
close
2632

2733
@facebook-github-bot close
28-
comment {author} tells me to close this issue. If you think it should still be opened let us know why.
34+
comment {author} has closed this issue. If you think it should remain open, let us know why.
2935
close
3036

3137
@facebook-github-bot bugfix
32-
comment Hey {issue_author}, we're a small team and rely on the community to fix issues that don't affect fb apps. If you're sure this is a bug can you send a pull request with a fix?
38+
comment Hey {issue_author}, if you're sure this is a bug, can you send a pull request with a fix?
39+
add-label Help Wanted
40+
41+
@facebook-github-bot needs-repro
42+
comment Can you reproduce the issue using [Snack](http://snack.expo.io)? This step is necessary for people to be able to see and debug the issue being reported.
43+
add-label Needs more information
44+
45+
@facebook-github-bot cannot-repro
46+
comment Thanks for opening the issue! It does not appear like a community member will be able to reliably reproduce this issue. This may be for several reasons; perhaps it affects a particular app but a minimal repro has not been provided, or the issue may be sporadic. As it happens, we need a concrete set of steps that can demonstrably reproduce the issue as this will allow your fellow community members to validate a fix. We'll close the issue for now, but feel free to submit a new issue once you're able to reliably reproduce the issue locally. Thanks for your understanding!
47+
close
3348

3449
@facebook-github-bot reopen
3550
comment Okay, reopening this issue.
3651
reopen
3752

3853
@facebook-github-bot feature
39-
comment Hey {issue_author}! Thanks for opening the issue, however it looks like a feature request. As noted in the [Issue template](https://github.com/facebook/react-native/blob/master/.github/ISSUE_TEMPLATE.md) we'd like to use the GitHub issues to track bugs only. Can you implement the feature as a standalone npm module? If not consider sending a pull request or a create an entry on [Canny](https://react-native.canny.io/feature-requests/). It has a voting system and if the feature gets upvoted enough it might get implemented. Closing this now, thanks for understanding!
54+
comment Hey {issue_author}! Thanks for opening the issue, however it looks like a feature request. As noted in the [Issue template](https://raw.githubusercontent.com/facebook/react-native/master/.github/ISSUE_TEMPLATE.md) we'd like to use the GitHub issues to track bugs only. Can you implement the feature as a standalone npm module? If not, consider sending a pull request or a creating an entry on [Canny](https://react-native.canny.io/feature-requests/). It has a voting system and if the feature gets upvoted enough it might get implemented. Closing this now, thanks for understanding!
55+
add-label Feature Request
4056
close
4157

4258
@facebook-github-bot cla
4359
comment Hey {issue_author}! Thanks for sending this pull request! We would love to review your changes however it looks like you haven't signed the CLA yet. You can do so at https://code.facebook.com/cla.
4460

4561
@facebook-github-bot icebox
46-
comment {author} tells me to close this issue because it has been inactive for a while. If you think it should still be opened let us know why.
62+
comment {author} tells me to close this issue because it has been inactive for a while. It's possible that the bug has been fixed since this issue was originally submitted, or perhaps it is not affecting a great amount of people, or a workaround has been provided. Either way, we're going to close this in order to allow the community to focus on more pressing issues. If you strongly believe this issue should remain open, please let us know why.
4763
add-label Icebox
4864
close

0 commit comments

Comments
 (0)