diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b5d0c744d..ee69e85ce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,6 +73,7 @@ Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe #### 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, * 2 spaces for indentation (no tabs) * "Attractive" diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 8183779c3..5e2ddd310 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -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. -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? ------------------------------------------------------------------ -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 +None of the above, create a bug report ------------------------------------------------------------------ -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 **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? +- [ ] 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? diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 3b3d851da..4ef624d58 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -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? -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)** -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** diff --git a/bots/IssueGuidelines.md b/docs/IssueGuidelines.md similarity index 98% rename from bots/IssueGuidelines.md rename to docs/IssueGuidelines.md index 1453ebd0c..d52ece37e 100644 --- a/bots/IssueGuidelines.md +++ b/docs/IssueGuidelines.md @@ -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 Comment e.g. `@facebook-github-bot duplicate #123`. This will add a comment and close the issue. diff --git a/docs/PullRequestGuidelines.md b/docs/PullRequestGuidelines.md new file mode 100644 index 000000000..d4805c6d5 --- /dev/null +++ b/docs/PullRequestGuidelines.md @@ -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. \ No newline at end of file