From 1f6ad46598cdfaf874d8d64b2ce0f56bf4704084 Mon Sep 17 00:00:00 2001 From: Martin Konicek Date: Wed, 17 Feb 2016 15:57:27 -0800 Subject: [PATCH] PR and Issue templates Reviewed By: mkonicek Differential Revision:D2946749 Ninja: GitHub-only fb-gh-sync-id: ac8a316ca4c2982a063040d57ddc1f279b81b59d shipit-source-id: ac8a316ca4c2982a063040d57ddc1f279b81b59d --- ISSUE_TEMPLATE.md | 16 ++++++++++++++++ PULL_REQUEST_TEMPLATE.md | 13 +++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 ISSUE_TEMPLATE.md create mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..a1a214ae3 --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,16 @@ +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. + +Here are good ways to get help: + +- If you **don't know how to do something** or **not sure you've found a bug**, ask on [StackOverflow](http://stackoverflow.com/questions/tagged/react-native) with the tag `react-native`. StackOverflow is amazing for Q&A and it is likely the community will see and answer your question there. + +- If this is a **feature request**, please report it on [Product Pains](https://productpains.com/product/react-native/). It has a ranking feature that lets us focus on the most important issues the community is experiencing. + +- Is this something you can debug and fix quickly? **Send a pull request!** + +If you want to file a GitHub issue, make sure it is actionable so someone can help: + +- Provide **screenshots** where appropriate +- What's the **version** of React Native you're using? +- Does this occur on iOS, Android or both? +- The operating system: Mac, Linux or Windows diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..875b1d6ed --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,13 @@ +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. + +**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. + +Make sure tests pass on Circle CI. + +**Code formatting** + +See the simple [style guide](https://github.com/facebook/react-native/blob/master/CONTRIBUTING.md#style-guide).