From f2c066a76e02bd3819fdf1ac96dcd7a203b1e57b Mon Sep 17 00:00:00 2001 From: Zach Plata Date: Thu, 21 May 2026 11:57:49 -0500 Subject: [PATCH] chore: standardize issue reporting form --- .github/ISSUE_TEMPLATE/config.yml | 8 + ...i-have-a-problem-with-rive-react-native.md | 59 ------- .../ISSUE_TEMPLATE/runtime-issue-template.yml | 163 ++++++++++++++++++ 3 files changed, 171 insertions(+), 59 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/i-have-a-problem-with-rive-react-native.md create mode 100644 .github/ISSUE_TEMPLATE/runtime-issue-template.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..09114f39 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Rive Documentation + url: https://rive.app/docs/runtimes/react-native/react-native + about: Please refer to the Rive documentation for feature use, supported versions, and troubleshooting steps before submitting an issue. + - name: Rive Community Support + url: https://community.rive.app/ + about: For general questions and answers, please use the Rive Community. diff --git a/.github/ISSUE_TEMPLATE/i-have-a-problem-with-rive-react-native.md b/.github/ISSUE_TEMPLATE/i-have-a-problem-with-rive-react-native.md deleted file mode 100644 index 150d82cc..00000000 --- a/.github/ISSUE_TEMPLATE/i-have-a-problem-with-rive-react-native.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -name: I have a problem with rive-react-native -about: Tell us what's wrong -title: '' -labels: '' -assignees: '' - ---- - -<-- Thanks for using Rive! - -If something isn't working like you expected, please: -- Make sure you've updated rive-react-native to the latest version: - https://www.npmjs.com/package/rive-react-native -- Check out our help center - https://help.rive.app/ -- You can file a new feature request at - https://feedback.rive.app/ - -If you think you found a bug or if you can't find what you're looking for -in our docs, fill out the template below. - ---> - -### Description -<-- A clear and concise description of what the problem is. --> - -### Provide a Repro -<-- -Please provide the most **minimal repro** you can: -- If the problem is small enough, paste a code snippet -- Otherwise, you can attach a ZIP archive or paste a link to a GitHub repository with the bundle that reproduces the issue - ---> - -#### Source `.riv`/`.rev` file -<-- -Attaching runtime-exported `.riv` file that reproduces the issue is immensely helpful for our team to identify the problem as fast as possible and fix it. -Please also include the source (`.rev`) by [downloading a backup](https://help.rive.app/editor/exporting#for-backup) from the Editor. - -N.B. Because GitHub only supports certain file types use a ZIP archive to upload `.riv`/`.rev` files to this issue. - -You can also privately share the `.riv`/`.rev` file with us at hello@rive.app. ---> - -### Expected behavior -<-- A clear and concise description of what you expected to happen. --> - -#### Screenshots -<-- If applicable, add screenshots to help explain your problem. --> - -![Screenshot](url) -### Device & Versions (please complete the following information) -- Device: [e.g. Android Emulator, iOS Simulator] -- OS: [e.g. Android SDK API Level 30, iOS 14.5] -- NPM Version: [Copy-paste the output of `npm --version` e.g.: `7.10.2`] - -#### Additional context -<-- Add any other context about the problem here. --> diff --git a/.github/ISSUE_TEMPLATE/runtime-issue-template.yml b/.github/ISSUE_TEMPLATE/runtime-issue-template.yml new file mode 100644 index 00000000..62d1a32c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/runtime-issue-template.yml @@ -0,0 +1,163 @@ +name: Problem with the Rive React Native Runtime +description: Report a bug or unexpected behavior in the Rive React Native runtime. +body: + - type: markdown + attributes: + value: | + Thanks for using Rive! Before filing an issue, please: + - Confirm the issue is still present in the latest version: `npm install rive-react-native@latest` or `yarn add rive-react-native@latest` + - Ensure the issue is related to `rive-react-native` and not the new Rive React Native runtime, `@rive-app/react-native` (built with Nitro) + - Check the [Rive documentation](https://rive.app/docs/runtimes/react-native/react-native) + - Search for help on the [Rive community forums](https://community.rive.app/) + + - type: checkboxes + id: preflight + attributes: + label: Submission checklist + options: + - label: I have confirmed the issue is present in the latest version of `rive-react-native` + required: true + - label: I have searched the documentation and forums and could not find an answer + required: true + - label: I have searched existing issues and this is not a duplicate + required: true + + - type: textarea + id: description + attributes: + label: Description + description: What issue are you running into? What's your expected behavior? Please include a full stack trace if one is available. + placeholder: Describe the issue you're experiencing + validations: + required: true + + - type: input + id: rive_version_working + attributes: + label: Previous working version + description: Has this ever worked before? If so, which version was it working on? + + - type: textarea + id: repro-description + attributes: + label: Reproduction steps / code + description: | + Please provide the most **minimal reproduction** you can. Paste a code snippet if the problem is small enough. Or share a link to a minimal GitHub repository that reproduces the issue. + + Alternatively, you can upload a .zip of your reproduction in the next question. + placeholder: | + ```tsx + // paste your code here + ``` + + - type: upload + id: repro-files + attributes: + label: Upload your reproduction files / stack trace + description: | + If your reproduction is more complex, you can upload a .zip of your project. + Include a file with your stack trace if available as well if you cannot provide it above. + Please make sure to include a `README` with instructions on how to run the reproduction. + + - type: upload + id: riv_file + attributes: + label: Source `.riv` / `.rev` file + description: | + If you are able, attaching the runtime-exported `.riv` file (and ideally the source `.rev` backup) is immensely helpful for reproducing and fixing the issue quickly. + + Note: Use a ZIP archive to upload `.riv`/`.rev` files (GitHub only supports certain file types). You can also share files privately at support@rive.app. + validations: + required: false + + - type: upload + id: screenshots + attributes: + label: Screenshots / video + description: If applicable, add screenshots or a screen recording to help explain the problem. + validations: + required: false + + - type: input + id: rive_rn_version + attributes: + label: "`rive-react-native` version" + description: Which version of `rive-react-native` are you using? + placeholder: "e.g. 9.8.3" + validations: + required: true + + - type: dropdown + id: platform + attributes: + label: Platform + description: Which platform(s) are you experiencing this issue on? + options: + - iOS only + - Android only + - Both iOS and Android + validations: + required: true + + - type: input + id: rn_version + attributes: + label: React Native version + description: Which version of React Native are you using? You can find this in your `package.json`. + placeholder: "e.g. 0.76.0" + validations: + required: true + + - type: dropdown + id: expo_setup + attributes: + label: Expo setup + description: Are you using Expo? + options: + - Not using Expo (bare React Native) + - Expo Go + - Expo Dev Client + - Expo prebuild + validations: + required: true + + - type: input + id: expo_sdk_version + attributes: + label: Expo SDK version + description: If you are using Expo, which SDK version are you using? + placeholder: "e.g. 52.0.0" + + - type: textarea + id: rn_info + attributes: + label: React Native environment info + description: Paste the output of `npx react-native info` here. + placeholder: | + ``` + paste output here + ``` + + - type: input + id: device + attributes: + label: Device + placeholder: "e.g. iPhone 15 Pro, Pixel 7, Android Emulator, iOS Simulator" + validations: + required: true + + - type: input + id: os_version + attributes: + label: OS version + placeholder: "e.g. iOS 17.4, Android 14" + validations: + required: true + + - type: textarea + id: additional_context + attributes: + label: Additional context + description: Any other context about the problem (navigation libraries, Metro config, native module conflicts, frequency of occurrence, etc.). + validations: + required: false