react-query/.github/ISSUE_TEMPLATE/bug_report.yml

name: '🐛 Bug report'
description: Report a reproducible bug or regression
body:
  - type: markdown
    attributes:
      value: |
        Thank you for reporting an issue :pray:.

        This issue tracker is for reporting reproducible bugs or regression's found in [TanStack Query](https://github.com/TanStack/query)
        If you have a question about how to achieve something and are struggling, please post a question
        inside of TanStack Query's [Discussions tab](https://github.com/TanStack/query/discussions)

        Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
         - TanStack Query's [Discussions tab](https://github.com/TanStack/query/discussions)
         - TanStack Query's [Open Issues](https://github.com/TanStack/query/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
         - TanStack Query's [Closed Issues](https://github.com/TanStack/query/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed)

        The more information you fill in, the better the community can help you.
  - type: textarea
    id: description
    attributes:
      label: Describe the bug
      description: Provide a clear and concise description of the challenge you are running into.
    validations:
      required: true
  - type: input
    id: link
    attributes:
      label: Your minimal, reproducible example
      description: |
        Please add a link to a minimal reproduction.
        Note:
        - Your bug may get fixed much faster if we can run your code and it doesn't have dependencies other than React/Solid/Vue/Svelte.
        - To create a shareable code example for web, you can use CodeSandbox (https://codesandbox.io/s/new) or Stackblitz (https://stackblitz.com/).
        - Please make sure the example is complete and runnable - e.g. avoid localhost URLs.
        - To stub out real api requests - Promise.resolve and Promise.reject are good options for easy reproduction
        - Feel free to fork any of the official examples to reproduce your issue: https://tanstack.com/query/latest/docs/framework/react/examples/simple
        - For React Native, you can use: https://snack.expo.dev/
        - For TypeScript related issues only, a TypeScript Playground link might be sufficient: https://www.typescriptlang.org/play
        - Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve.
      placeholder: |
        e.g. Code Sandbox, Stackblitz, Expo Snack or TypeScript playground
    validations:
      required: true
  - type: textarea
    id: steps
    attributes:
      label: Steps to reproduce
      description: Describe the steps we have to take to reproduce the behavior.
      placeholder: |
        1. Go to '...'
        2. Click on '....'
        3. Scroll down to '....'
        4. See error
    validations:
      required: true
  - type: textarea
    id: expected
    attributes:
      label: Expected behavior
      description: Provide a clear and concise description of what you expected to happen.
      placeholder: |
        As a user, I expected ___ behavior but i am seeing ___
    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
  - type: textarea
    id: screenshots_or_videos
    attributes:
      label: Screenshots or Videos
      description: |
        If applicable, add screenshots or a video to help explain your problem.
        For more information on the supported file image/file types and the file size limits, please refer
        to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
      placeholder: |
        You can drag your video or image files inside of this editor ↓
  - type: textarea
    id: platform
    attributes:
      label: Platform
      description: |
        Please let us know which Operting System, Browser and Browser version you were using when the issue occurred.
      placeholder: |
        - OS: [e.g. macOS, Windows, Linux, iOS, Android]
        - Browser: [e.g. Chrome, Safari, Firefox, React Native]
        - Version: [e.g. 91.1]
    validations:
      required: true
  - type: dropdown
    id: adapter
    attributes:
      label: Tanstack Query adapter
      description: |
        Please let us know which adapter of TanStack Query you were using when the issue occurred.
      options:
        - react-query
        - solid-query
        - svelte-query
        - vue-query
        - angular-query
        - vanilla
  - type: input
    id: rq-version
    attributes:
      label: TanStack Query version
      description: |
        Please let us know the exact version of TanStack Query you were using when the issue occurred. Please don't just put in "latest", as this is subject to change.
      placeholder: |
        e.g. v5.51.9
    validations:
      required: true
  - type: input
    id: ts-version
    attributes:
      label: TypeScript version
      description: |
        If you are using TypeScript, please let us know the exact version of TypeScript you were using when the issue occurred.
      placeholder: |
        e.g. v5.5.4
  - type: textarea
    id: additional
    attributes:
      label: Additional context
      description: Add any other context about the problem here.