From 4412b4cc5c94aebe7a9f50b92244b9828e9c6b15 Mon Sep 17 00:00:00 2001 From: Krystof Woldrich <31292499+krystofwoldrich@users.noreply.github.com> Date: Mon, 14 Oct 2024 13:04:17 +0200 Subject: [PATCH] misc: Use form template for bug reports (#4166) --- .github/ISSUE_TEMPLATE/BUG_REPORT.md | 71 ----------------- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 108 ++++++++++++++++++++++++++ 2 files changed, 108 insertions(+), 71 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.md create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.yml diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md deleted file mode 100644 index 82f416307..000000000 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -name: 🐞 Bug Report -about: Tell us about something that's not working the way we (probably) intend. -labels: ["Platform: React-Native", "Type: 🪲 Bug"] ---- - -**OS:** -- [ ] Windows -- [ ] MacOS -- [ ] Linux - -**Platform:** -- [ ] iOS -- [ ] Android - -**SDK:** -- [ ] `@sentry/react-native` (>= 1.0.0) -- [ ] `react-native-sentry` (<= 0.43.2) - -**SDK version:** 0.0.0 - -**`react-native` version:** 0.0.0 - -**Are you using Expo?** -- [ ] Yes -- [ ] No - -**Are you using sentry.io or on-premise?** -- [ ] sentry.io (SaaS) -- [ ] on-premise - -**If you are using sentry.io, please post a link to your issue so we can take a look:** - -[Link to issue] - -**Configuration:** - -(`@sentry/react-native`) -``` -Sentry.init({ - dsn: 'https://...@sentry.io/...' - // other options -}); -``` - -or - -(`react-native-sentry`) -``` -Sentry.config( - 'https://...@sentry.io/...' - // other options - ).install(); -``` - ---- -**I have the following issue:** - -[Description] - -**Steps to reproduce:** -- Step 1 -- Step 2 - -**Actual result:** - -[Actual result] - -**Expected result:** - -[Expected result] diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml new file mode 100644 index 000000000..d214037c9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -0,0 +1,108 @@ +name: "🐞 Bug Report" +description: "Tell us about something that's not working the way we (probably) intend." +labels: ["Platform: React-Native", "Type: 🪲 Bug"] +body: + - type: dropdown + id: environment + validations: + required: true + attributes: + label: "What React Native libraries do you use?" + description: "Select all options that describe your application." + multiple: true + options: + - "React Native without Frameworks" + - "React Navigation" + - "Hermes" + - "RN New Architecture" + - "Expo Application Services (EAS)" + - "Expo (mobile only)" + - "Expo Web" + - "Expo Router" + - "React Native Web" + - "React Native Navigation by Wix" + + - type: dropdown + id: sentry + validations: + required: true + attributes: + label: "Are you using sentry.io or on-premise?" + description: "Select exactly one option." + options: + - "sentry.io (SaS)" + - "on-premise (Self-Hosted)" + + - type: input + id: version + validations: + required: true + attributes: + label: "@sentry/react-native SDK Version" + description: "If the issue started after the SDK upgrade, please input both old and new versions." + placeholder: "5.33.1 ← should look like this" + + - type: textarea + id: doctor + validations: + required: true + attributes: + label: "How does your development environment look like?" + description: "Output of the command `npx react-native@latest info` or manully describe your development environment?" + placeholder: |- + info Fetching system and libraries information... + OS: OS version + Node: Your version + Yarn: Yarn version + Expo SDK: Expo SDK version + react: React version + react-native: React Native version + hermesEnabled: bool + newArchEnabled: bool + + - type: textarea + id: init + validations: + required: true + attributes: + label: "Sentry.init()" + description: "Code snipped of Sentry initialization from your application." + placeholder: |- + Sentry.init({ + dsn: 'https://...@sentry.io/...' + // other options + }); + + - type: textarea + id: repro + validations: + required: true + attributes: + label: "Steps to Reproduce" + description: "How can we see what you're seeing? Specific is terrific." + placeholder: |- + 1. Build Android using `npx react-native run-android --mode Debug` + 2. Start Metro Dev server using `npx react-native start` + 3. Click on button executing `Sentry.capture(new Error("This is not captured :("))` + + - type: textarea + id: expected + validations: + required: true + attributes: + label: "Expected Result" + + - type: textarea + id: actual + validations: + required: true + attributes: + label: "Actual Result" + description: "JS Console? iOS Console? Logcat? Screenshots? Yes, please." + + - type: markdown + attributes: + value: |- + + ## Thank you 🙏 + Check our [triage docs](https://open.sentry.io/triage/) for what to expect next.