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
This commit is contained in:
Martin Konicek 2016-03-04 09:14:32 -08:00 committed by Facebook Github Bot 4
parent cf8bb75c19
commit f0f1f61b40
5 changed files with 23 additions and 26 deletions

View File

@ -73,6 +73,7 @@ Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
#### General #### General
* **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.
* Add trailing commas, * Add trailing commas,
* 2 spaces for indentation (no tabs) * 2 spaces for indentation (no tabs)
* "Attractive" * "Attractive"

View File

@ -2,30 +2,20 @@ 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. There are just too many issues for us to manage properly.
Please read the following tips before filing an issue: Do the checklist before filing an issue:
Is this something you can debug and fix? - [ ] 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.
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.
Have a question or not sure you've found a bug? None of the above, create a bug report
-----------------------------------------------------------------
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.
Make sure you **include a short code snippet to demonstrate the problem**.
Have an idea for a feature?
------------------------------------
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.
None of the above, want to create a GitHub issue
------------------------------------------------------------------ ------------------------------------------------------------------
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. 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.
- If this is a bug, provide a **minimal code snippet** that reproduces it - [ ] Provide a **minimal code snippet** / [rnplay](https://rnplay.org/) example that reproduces the bug.
- Provide **screenshots** where appropriate - [ ] Provide **screenshots** where appropriate
- What's the **version** of React Native you're using? - [ ] What's the **version** of React Native you're using?
- Does this occur on iOS, Android or both? - [ ] Does this occur on iOS, Android or both?
- Are you using Mac, Linux or Windows? - [ ] Are you using Mac, Linux or Windows?

View File

@ -1,14 +1,16 @@
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: Thanks for submitting a pull request! Please provide enough information so that others can review your pull request:
(You can skip this if you're fixing a typo or adding an app to the Showcase.)
Explain the **motivation** for making this change. What existing problem does the pull request solve? Explain the **motivation** for making this change. What existing problem does the pull request solve?
Example: When saying "Add a function to do X", explain why it is necessary to have a way to do X. Example: When "Adding a function to do X", explain why it is necessary to have a way to do X.
**Test plan (required)** **Test plan (required)**
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. Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.
Make sure tests pass on Circle CI. Make sure tests pass on both Travis and Circle CI.
**Code formatting** **Code formatting**

View File

@ -1,4 +1,4 @@
Use the following tips when responding to GitHub issues. Here are some tips on how to manage GitHub issues efficiently:
### An issue is a duplicate of another issue ### An issue is a duplicate of another issue
Comment e.g. `@facebook-github-bot duplicate #123`. This will add a comment and close the issue. Comment e.g. `@facebook-github-bot duplicate #123`. This will add a comment and close the issue.

View File

@ -0,0 +1,4 @@
Here are some tips on how you can help review pull requests:
- 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.
- 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.