From d3207e075199a634f066a41335fed0c68028557c Mon Sep 17 00:00:00 2001 From: Pascal Thomet Date: Mon, 2 Dec 2024 18:34:18 +0100 Subject: [PATCH] Add GitHub issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 79 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 17 +++++ .github/ISSUE_TEMPLATE/custom.md | 30 +++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 31 +++++++++ 4 files changed, 157 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/custom.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..4a8d8e9f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,79 @@ +--- +name: Bug Report +about: Report a bug +title: "" +labels: +assignees: '' + +--- +` is a comment and should be removed. +* Remove the sections which are not applicable to your issue. + + +If this is the first time you interact on this project, welcome to the community! + +In this case, please give a bit of information about yourself, and how you are using Hello ImGui (which project, how long you have been using it, etc.). + +Note: +- The author is French, so remember that saying "Hello" or "Bonjour" is a good way to get him more willing to help you! ;-) +- Please check existing [open issues](../issues) and [discussions](../discussions) for similar reports before submitting a new one. + +--> + + +### Describe the bug + + + +**Minimal reproducible example** + + +For C++: +```cpp +// Your code here... (a compilable example, including the main function) +``` + +For Python: +```python +# Your code here... (a runnable example) +``` + +**To Reproduce** + + +**Additional context** + + +### Environment and configuration +**Version**: +- Version of Hello ImGui: Version number or commit hash and/or date + +**Platform**: +- OS: [e.g., Windows 10, Linux, Mac, iOS, Android, emscripten] +- Python or C++: [e.g., Python 3.10, C++ 17] + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..5d2620ae --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,17 @@ +blank_issues_enabled: false +contact_links: + - name: Hello ImGui Documentation + url: https://pthom.github.io/hello_imgui/ + about: This is the official documentation for Hello ImGui. + - name: Dear ImGui Manual + url: https://pthom.github.io/imgui_manual_online/manual/imgui_manual.html + about: This is an interactive manual for Dear ImGui. Its show all the widgets and features of Dear ImGui with C++ and Python code. + - name: Discussions + url: https://github.com/pthom/hello_imgui/discussions + about: This is the official place to discuss about Hello ImGui. + - name: Dear ImGui Bundle Documentation + url: https://pthom.github.io/imgui_bundle/ + about: This is the official documentation for Dear ImGui Bundle. + - name: Dear ImGui Bundle Interactive Manual + url: https://traineq.org/ImGuiBundle/emscripten/bin/demo_imgui_bundle.html + about: This is the official interactive demo for Dear ImGui Bundle, with lots of examples (with code) diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md new file mode 100644 index 00000000..7baa0889 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/custom.md @@ -0,0 +1,30 @@ +--- +name: Custom Issue +about: Report an issue that doesn't fit into other categories +title: "" +labels: '' +assignees: '' + +--- + + +` is a comment and should be removed. +* Remove the sections which are not applicable to your issue. + + +If this is the first time you interact on this project, welcome to the community! + +In this case, please give a bit of information about yourself, and how you are using Dear ImGui Bundle (which project, how long you have been using it, etc.). + +Note: The author is French, so remember that saying "Hello" or "Bonjour" is a good way to get him more willing to help you! ;-) + +--> + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..d111c703 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,31 @@ +--- +name: Feature Request +about: Suggest a new feature or improvement +title: "" +labels: enhancement +assignees: '' + +--- + + +` is a comment and should be removed. +* Remove the sections which are not applicable to your issue. + + +If this is the first time you interact on this project, welcome to the community! + +In this case, please give a bit of information about yourself, and how you are using Dear ImGui Bundle (which project, how long you have been using it, etc.). + +Note: The author is French, so remember that saying "Hello" or "Bonjour" is a good way to get him more willing to help you! ;-) + +--> + +