From ecddf3cb077d6d1b542b3d0cd8f87d30fb2030be Mon Sep 17 00:00:00 2001 From: Lauren Tan Date: Fri, 17 May 2024 10:29:29 -0700 Subject: [PATCH] Add issue template for React Compiler Adds a GitHub issue template form so we can automatically categorize issues and get more information upfront. I mostly referenced the DevTools bug report template and made some tweaks. ghstack-source-id: 5bfc728a625f367932fc21263e82681079d3ac65 Pull Request resolved: https://github.com/facebook/react/pull/29140 --- .../ISSUE_TEMPLATE/compiler_bug_report.yml | 57 +++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/compiler_bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/compiler_bug_report.yml b/.github/ISSUE_TEMPLATE/compiler_bug_report.yml new file mode 100644 index 0000000000..fc7952fd5a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/compiler_bug_report.yml @@ -0,0 +1,57 @@ +name: "⚛️ ✨ Compiler bug report" +description: "Report a problem with React Compiler. Please provide enough information that we can reproduce the problem." +title: "[Compiler Bug]: " +labels: ["Component: Optimizing Compiler", "Type: Bug", "Status: Unconfirmed"] +body: +- type: checkboxes + attributes: + label: What kind of issue is this? + description: | + Please indicate if this issue affects the following tools provided by React Compiler. + options: + - label: React Compiler core (the JS output is incorrect, or your app works incorrectly after optimization) + - label: babel-plugin-react-compiler (build issue installing or using the Babel plugin) + - label: eslint-plugin-react-compiler (build issue installing or using the eslint plugin) + - label: react-compiler-healthcheck (build issue installing or using the healthcheck script) +- type: input + attributes: + label: Link to repro + description: | + Please provide a repro by either sharing a [Playground link](https://playground.react.dev), or a public GitHub repo so the React team can reproduce the error being reported. Please do not share localhost links! + placeholder: | + e.g. public GitHub repo, or Playground link + validations: + required: true +- type: textarea + attributes: + label: Repro steps + description: | + What were you doing when the bug happened? Detailed information helps maintainers reproduce and fix bugs. + + Issues filed without repro steps will be closed. + placeholder: | + Example bug report: + 1. Log in with username/password + 2. Click "Messages" on the left menu + 3. Open any message in the list + validations: + required: true +- type: dropdown + attributes: + label: How often does this bug happen? + description: | + Following the repro steps above, how easily are you able to reproduce this bug? + options: + - Every time + - Often + - Sometimes + - Only once + validations: + required: true +- type: input + attributes: + label: What version of React are you using? + description: | + Please provide your React version in the app where this issue occurred. + validations: + required: true