|
| 1 | +name: "Ask a question, report a bug, request a feature, etc." |
| 2 | +description: "Ask any question, discuss best practices, report a bug, request a feature." |
| 3 | +body: |
| 4 | + - type: markdown |
| 5 | + attributes: |
| 6 | + value: | |
| 7 | + FOR FIRST-TIME USERS ISSUES COMPILING/LINKING/RUNNING, please use [GitHub Discussions](https://github.com/ocornut/imgui/discussions) |
| 8 | + 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, tagged, cross-referenced database of Dear ImGui contents. |
| 9 | +
|
| 10 | + 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. |
| 11 | +
|
| 12 | + **If you are using Dear ImGui as part of a job that you are being well-paid for** and your company is not a sponsor. Please be mindful that this is a Free Software and you might be about to ask volunteers to help you doing your job. Please put extra effort describing your issue or question properly. If your company is wealthy, please read [Funding](https://github.com/ocornut/imgui/wiki/Funding) and consider getting in touch. |
| 13 | + - type: markdown |
| 14 | + attributes: |
| 15 | + value: | |
| 16 | + **Prerequisites:** |
| 17 | + - I have read [Frequently Asked Questions](https://github.com/ocornut/imgui/blob/master/docs/FAQ.md). |
| 18 | + - I have read [Contributing Guidelines -> General Advices](https://github.com/ocornut/imgui/blob/master/docs/CONTRIBUTING.md#getting-started--general-advice). |
| 19 | + - 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). |
| 20 | + - I have searched [Github Issues and PR](https://github.com/ocornut/imgui/issues?q=) for discussion of similar topics. |
| 21 | +
|
| 22 | + ---- |
| 23 | + - type: input |
| 24 | + id: specs_version |
| 25 | + attributes: |
| 26 | + label: "Version/Branch of Dear ImGui:" |
| 27 | + description: "(please specify if you have made substantial modifications to your copy)" |
| 28 | + value: "Version 1.XX, Branch: XXX (master/docking/etc.)" |
| 29 | + placeholder: "Version 1.XX, Branch: XXX (master/docking/etc.)" |
| 30 | + validations: |
| 31 | + required: true |
| 32 | + - type: input |
| 33 | + id: specs_backend |
| 34 | + attributes: |
| 35 | + label: "Back-ends:" |
| 36 | + description: (or specify when using custom engine/back-ends) |
| 37 | + value: "imgui_impl_XXX.cpp + imgui_impl_XXX.cpp" |
| 38 | + placeholder: "imgui_impl_XXX.cpp + imgui_impl_XXX.cpp or n/a" |
| 39 | + validations: |
| 40 | + required: true |
| 41 | + - type: input |
| 42 | + id: specs_compiler_os |
| 43 | + attributes: |
| 44 | + label: "Compiler, OS:" |
| 45 | + placeholder: "e.g. Windows 11 + MSVC 2022, macOS + Clang 12, Linux + GCC etc." |
| 46 | + validations: |
| 47 | + required: true |
| 48 | + - type: textarea |
| 49 | + id: specs_full |
| 50 | + attributes: |
| 51 | + label: "Full config/build information:" |
| 52 | + placeholder: | |
| 53 | + (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) |
| 54 | + validations: |
| 55 | + required: false |
| 56 | + - type: textarea |
| 57 | + id: issue_description |
| 58 | + attributes: |
| 59 | + label: "Details:" |
| 60 | + 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." |
| 61 | + value: | |
| 62 | + **My Issue/Question:** |
| 63 | +
|
| 64 | + XXX _(please provide as much context as possible)_ |
| 65 | + validations: |
| 66 | + required: true |
| 67 | + - type: textarea |
| 68 | + id: screenshots |
| 69 | + attributes: |
| 70 | + label: "Screenshots/Video:" |
| 71 | + description: "Attach screenshots or gif/videos to clarify the context. They often convey useful information that is omitted by the description." |
| 72 | + placeholder: "(You can drag files here)" |
| 73 | + validations: |
| 74 | + required: false |
| 75 | + - type: textarea |
| 76 | + id: repro_code |
| 77 | + attributes: |
| 78 | + label: "Minimal, Complete and Verifiable Example code:" |
| 79 | + 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." |
| 80 | + value: | |
| 81 | + ```cpp |
| 82 | + // Here's some code anyone can copy and paste to reproduce your issue |
| 83 | + ImGui::Begin("Example Bug"); |
| 84 | + MoreCodeToExplainMyIssue(); |
| 85 | + ImGui::End(); |
| 86 | + ``` |
| 87 | + validations: |
| 88 | + required: false |
| 89 | + - type: markdown |
| 90 | + attributes: |
| 91 | + value: | |
| 92 | + Thank you for taking the time to read prerequisites, filling this template and double-checking your message and your code! |
0 commit comments