name: Report a bug
description: Any errors that are not UI related.
labels: ["needs triage", "bug"]
body:
  - type: markdown
    attributes:
      value: >
        Before you go any further. Is this really a **🐛 bug**?

        If it's a question about how Lightning works, have a look at our [Lightning documentation](https://lightning.ai/lightning-docs/)
        or ask a question on our [Community Discord](https://discord.gg/VptPCZkGNa).

  - type: textarea
    attributes:
      label: Bug description
      description: A description of the 🐛bug🐛.
      placeholder: |
        A clear and concise description of what the bug is.

        Include steps to reproduce, the expected behaviour, and the actual behaviour.

        ```
        The error message you got, with the full traceback if available.
        ```
    validations:
      required: true

  - type: dropdown
    id: versions
    attributes:
      label: What version are you seeing the problem on?
      description: select all version where you have experienced this issue
      multiple: true
      options:
        - "v1.x"
        - "v2.1"
        - "v2.2"
        - "v2.3"
        - "v2.4"
        - "v2.5"
        - "master"
    validations:
      required: true

  - type: markdown
    attributes:
      value: "**Note: The rest of this form is optional, but filling it out may help us to provide better support.**"

  - type: input
    attributes:
      label: Reproduced in studio
      description: >
        Create a new Lightning Studio with code that reproduces the issue and share the link.
        Also include all the relevant files and data required to reproduce shared issue.
        In case the code does not crash, please add assert statements to show what is the real and expected output.
        A simple guide on how to create such a studio can be found [here](https://www.youtube.com/watch?v=YcW-2Zt_bFg&ab_channel=LightningAI).
      placeholder: https://lightning.ai/live-session/...
    validations:
      required: false
  - type: textarea
    attributes:
      label: How to reproduce the bug
      description: >
        In the special case when the issue can't be reproduced in a studio, provide steps and example code here.
      placeholder: |
        ```python
        # Sample code to reproduce the problem
        ```
      render: python
    validations:
      required: false

  - type: textarea
    attributes:
      label: Error messages and logs
      description: >
        Provide any error messages and/or logs
      placeholder: "# Copy the complete error messages and logs"
      value: |
        ```
        # Error messages and logs here please
        ```
    validations:
      required: false

  - type: textarea
    attributes:
      label: Environment
      description: |
        Please provide details about your environment by copying and pasting the output from our environment collection script:
        https://raw.githubusercontent.com/Lightning-AI/lightning/master/requirements/collect_env_details.py
        (For security purposes, please check the contents of the script before running it)
        You can get the script and run it with:
        ```console
        wget https://raw.githubusercontent.com/Lightning-AI/lightning/master/requirements/collect_env_details.py
        python collect_env_details.py
        ```

        You can also fill out the list below manually.
      value: |
        <details>
          <summary>Current environment</summary>

        ```
        #- PyTorch Lightning Version (e.g., 2.5.0):
        #- PyTorch Version (e.g., 2.5):
        #- Python version (e.g., 3.12):
        #- OS (e.g., Linux):
        #- CUDA/cuDNN version:
        #- GPU models and configuration:
        #- How you installed Lightning(`conda`, `pip`, source):
        ```

        </details>
    validations:
      required: false

  - type: textarea
    attributes:
      label: More info
      description: Add any other info about the issue here.
    validations:
      required: false

  - type: markdown
    attributes:
      value: "**Happy engineering!**"