diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 5e2ddd3107..b55e54ac8a 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,21 +1,42 @@ -Hey there and thank you for using React Native! +## Hey there and thank you for using React Native! -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. +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. Before opening a new issue, make sure to carefully read the following guidelines. -Do the checklist before filing an issue: +- Is this something you can **debug and fix**? + Send a pull request! Bug fixes and documentation fixes are welcome. +- Have a **usage** question? + We use GitHub Issues for bugs. Ask your usage question on Stack Overflow: http://stackoverflow.com/questions/tagged/react-native +- Have an idea for a **feature**? + Post the feature request on Product Pains, which has a voting system to surface important issues: https://productpains.com/product/react-native/ -- [ ] Is this something you can **debug and fix**? Send a pull request! Bug fixes and documentation fixes are welcome. -- [ ] 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. -- [ ] 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. +GitHub issues should only be used for bugs. Make sure these boxes are checked before submitting your issue: +- [ ] You're using the latest release of React Native: https://github.com/facebook/react-native/releases -None of the above, create a bug report ------------------------------------------------------------------- +- [ ] You've searched through existing issues: https://github.com/facebook/react-native/issues + Chances are that your issue has been reported or resolved before. -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. +- [ ] You have filled out the template below, or provided an equivalent amount of detail. + Issues without sufficient information will be labeled 'Needs more information' and will be closed until there is enough information. -- [ ] Provide a **minimal code snippet** / [rnplay](https://rnplay.org/) example that reproduces the bug. -- [ ] Provide **screenshots** where appropriate -- [ ] What's the **version** of React Native you're using? -- [ ] Does this occur on iOS, Android or both? -- [ ] Are you using Mac, Linux or Windows? +Describe your issue in as much detail as possible. Provide **screenshots** where appropriate. Provide a **minimal code snippet** / [rnplay](https://rnplay.org/) example that reproduces the bug, or include a list of detailed list of steps that reproduce the issue. + +--- delete everything above this line before submitting your issue --- + +### Issue Description + +[FILL THIS OUT] + +### Steps to Reproduce / Code Snippets + +[FILL THIS OUT] + +#### Expected Results + +[FILL THIS OUT] + +### Additional Information + +* React Native version: [FILL THIS OUT] +* Platform(s) (iOS, Android, or both?): [FILL THIS OUT] +* Operating System (macOS, Linux, or Windows?): [FILL THIS OUT]