From 05e487a12ffee59b75db82995f3f826254444741 Mon Sep 17 00:00:00 2001 From: Nicolas Gallagher Date: Thu, 9 Jan 2020 16:16:37 -0800 Subject: [PATCH] Add GitHub issue templates (#17815) --- .github/ISSUE_TEMPLATE.md | 16 ++-------- .github/ISSUE_TEMPLATE/bug_report.md | 41 +++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/documentation.md | 13 ++++++++ .github/ISSUE_TEMPLATE/question.md | 29 +++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 37 ++++++++++++++-------- 5 files changed, 111 insertions(+), 25 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index f2f6a21e17..e19ec2cb10 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,14 +1,4 @@ - +👉 Please follow one of these issue templates: +- https://github.com/facebook/react/issues/new/choose -**Do you want to request a *feature* or report a *bug*?** - -**What is the current behavior?** - -**If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem. Your bug will get fixed much faster if we can run your code and it doesn't have dependencies other than React. Paste the link to your JSFiddle (https://jsfiddle.net/Luktwrdm/) or CodeSandbox (https://codesandbox.io/s/new) example below:** - -**What is the expected behavior?** - -**Which versions of React, and which browser / OS are affected by this issue? Did this work in previous versions of React?** +Note: to keep the backlog clean and actionable, issues may be immediately closed if they do not follow one of the above issue templates. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..e561f9d261 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,41 @@ +--- +name: "🐛 Bug Report" +about: Report a reproducible bug or regression. +title: 'Bug: ' +labels: 'Status: Unconfirmed' + +--- + + + +React version: + +## Steps To Reproduce + +1. +2. + + + +Link to code example: + + + +## The current behavior + + +## The expected behavior diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000000..57c380e2ac --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,13 @@ +--- +name: "📃 Documentation Issue" +about: This issue tracker is not for documentation issues. Please file documentation issues at https://github.com/reactjs/reactjs.org. +title: 'Docs: ' +labels: 'Resolution: Invalid' + +--- + +🚨 This issue tracker is not for documentation issues. 🚨 + +The React website is hosted on a separate repository. You may let the +team know about any issues with the documentation by opening an issue there: +- https://github.com/reactjs/reactjs.org/issues/new diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000000..dedcd02fcf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,29 @@ +--- +name: "🤔 Questions and Help" +about: This issue tracker is not for questions. Please ask questions at https://stackoverflow.com/questions/tagged/react. +title: 'Question: ' +labels: 'Resolution: Invalid', 'Type: Question' + +--- + +🚨 This issue tracker is not for questions. 🚨 + +As it happens, support requests that are created as issues are likely to be closed. We want to make sure you are able to find the help you seek. Please take a look at the following resources. + +## Coding Questions + +### https://stackoverflow.com/questions/tagged/react + +If you have a coding question related to React and React DOM, it might be better suited for Stack Overflow. It's a great place to browse through frequent questions about using React, as well as ask for help with specific questions. + +## Talk to other React developers + +### https://www.reactiflux.com/ + +Reactiflux is an active community of React and React Native developers. If you are looking for immediate assistance or have a general question about React, the #help-react channel is a good place to start. + +## Proposals + +### https://github.com/reactjs/rfcs + +If you'd like to discuss topics related to the future of React, or would like to propose a new feature or change before sending a pull request, please check out the discussions and proposals repository. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b8a0139bd9..a82527b0aa 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,14 +1,27 @@ -**Before submitting a pull request,** please make sure the following is done: + + +## Summary + + + +## Test Plan + +