imgui/.github/ISSUE_TEMPLATE/issue_template.yml

name: "Ask a question, report a bug, request a feature, etc."
description: "Ask any question, discuss best practices, report a bug, request a feature."
body:
  - type: markdown
    attributes:
      value: |
        FOR FIRST-TIME USERS ISSUES COMPILING/LINKING/RUNNING or LOADING FONTS, please use [GitHub Discussions](https://github.com/ocornut/imgui/discussions)
        For anything else: we are happy to use 'GitHub Issues' for many types of open-ended questions. We are encouraging 'Issues' becoming a large, centralized and cross-referenced database of Dear ImGui contents.

        Be mindful that messages are being sent to the e-mail box of "Watching" users. Try to proof-read your messages before sending them. Edits are not seen by those users.
  - type: markdown
    attributes:
      value: |
        **Prerequisites:**
        - I have read [Frequently Asked Questions](https://github.com/ocornut/imgui/blob/master/docs/FAQ.md).
        - I have read [Contributing Guidelines -> General Advices](https://github.com/ocornut/imgui/blob/master/docs/CONTRIBUTING.md#getting-started--general-advice).
        - I have read [Contributing Guidelines -> How to open an Issue](https://github.com/ocornut/imgui/blob/master/docs/CONTRIBUTING.md#how-to-open-an-issue).
        - I have searched [Github Issues and PR](https://github.com/ocornut/imgui/issues?q=) for discussion of similar topics.

        ----
  - type: input
    id: specs_version
    attributes:
      label: "Version/Branch of Dear ImGui:"
      description: "(please specify if you have made substantial modifications to your copy)"
      value: "Version 1.XX, Branch: XXX (master/docking/etc.)"
      placeholder: "Version 1.XX, Branch: XXX (master/docking/etc.)"
    validations:
      required: true
  - type: input
    id: specs_backend
    attributes:
      label: "Back-ends:"
      description: (or specify when using custom engine/back-ends)
      value: "imgui_impl_XXX.cpp + imgui_impl_XXX.cpp"
      placeholder: "imgui_impl_XXX.cpp  + imgui_impl_XXX.cpp or n/a"
    validations:
      required: true
  - type: input
    id: specs_compiler_os
    attributes:
      label: "Compiler, OS:"
      placeholder: "e.g. Windows 11 + MSVC 2022, macOS + Clang 12, Linux + GCC etc."
    validations:
      required: true
  - type: textarea
    id: specs_full
    attributes:
      label: "Full config/build information:"
      placeholder: |
        (If you can run, you may go to 'Demo->Tools->About Dear ImGui->Config/Build Info' to obtain detailed information that you can paste here)
    validations:
      required: false
  - type: textarea
    id: issue_description
    attributes:
      label: "Details:"
      description: "Try to be explicit with your goals, your expectations and what you have tried. Be mindful of [The XY Problem](https://xyproblem.info). What you have in mind or in your code is not obvious to other people. People frequently discuss problems and suggest incorrect solutions without first clarifying their goals. When requesting a new feature, please describe the usage context (how you intend to use it, why you need it, etc.). If you tried something and it failed, show us what you tried. If you are reporting a bug, explain what's the bug, how does it occur, etc. If you are reporting a crash, please include a debugger callstack."
      value: |
        **My Issue/Question:**

        XXX _(please provide as much context as possible)_
    validations:
      required: true
  - type: textarea
    id: screenshots
    attributes:
      label: "Screenshots/Video:"
      description: "Attach screenshots or gif/videos to clarify the context. They often convey useful information that is omitted by the description."
      placeholder: "(You can drag files here)"
    validations:
      required: false
  - type: textarea
    id: repro_code
    attributes:
      label: "Minimal, Complete and Verifiable Example code:"
      description: "Provide an [MCVE](https://stackoverflow.com/help/mcve) to demonstrate your problem. An ideal submission includes a small piece of code that anyone can paste into one of the examples applications (examples/*/main.cpp) or the demo (imgui_demo.cpp) to understand and reproduce it. Narrowing your problem to its shortest and purest form is the easiest way to understand it, explain it and fix it. Please test your shortened code to ensure it exhibits the problem. Often while creating the MCVE you will solve the problem! Many questions that are missing a standalone verifiable example are missing the actual cause of their issue in the description, which ends up wasting everyone's time."
      value: |
        ```cpp
        // Here's some code anyone can copy and paste to reproduce your issue
        ImGui::Begin("Example Bug");
        MoreCodeToExplainMyIssue();
        ImGui::End();
        ```
    validations:
      required: false
  - type: markdown
    attributes:
      value: |
        Thank you for taking the time to read prerequisites, filling this template and double-checking your message and your code!