Skip to content

Commit

Permalink
Add GitHub issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
pthom committed Dec 2, 2024
1 parent b53e2b4 commit d3207e0
Show file tree
Hide file tree
Showing 4 changed files with 157 additions and 0 deletions.
79 changes: 79 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
name: Bug Report
about: Report a bug
title: ""
labels:
assignees: ''

---
<!-- INSTRUCTIONS
Please fill in the sections below:
* Remove the comments (like this one) before submitting your issue:
anything between `<! --` and `-->` 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

<!-- Include here a clear and concise description of what the bug is -->

**Minimal reproducible example**
<!--
Please, please do try to provide a minimal reproducible example that reproduces the bug, either in C++ or Python.
See:
https://stackoverflow.com/help/minimal-reproducible-example
If not applicable, remove this part.
-->

For C++:
```cpp
// Your code here... (a compilable example, including the main function)
```

For Python:
```python
# Your code here... (a runnable example)
```

**To Reproduce**
<!-- If reproducing is complex, please specify the steps here.
Otherwise, remove this part.
1. ...
2. ...
3. ...
-->

**Additional context**
<!--
* If applicable, please include the error message or any relevant logs.
* Also include screenshots if relevant.
* Add any other context about the problem here.
Otherwise, remove this part.
-->

### 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]
<!--
If relevant, also include:
- Compiler (if applicable): [e.g., GCC 10.2, MSVC 2019]
- platform backend, e.g., SDL2, GLFW
- rendering backend, e.g., OpenGL, Vulkan, DirectX, Metal
If this part is not relevant, remove it.
-->
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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)
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/custom.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Custom Issue
about: Report an issue that doesn't fit into other categories
title: ""
labels: ''
assignees: ''

---


<!-- INSTRUCTIONS
Please fill in the sections below:
* Remove the comments (like this one) before submitting your issue:
anything between `<! --` and `-->` 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! ;-)

-->

<!--
**Describe your issue**
Explain why you think this feature would be useful.
-->
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Feature Request
about: Suggest a new feature or improvement
title: ""
labels: enhancement
assignees: ''

---


<!-- INSTRUCTIONS
Please fill in the sections below:
* Remove the comments (like this one) before submitting your issue:
anything between `<! --` and `-->` 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! ;-)

-->

<!--
**Describe the feature you'd like**
A clear and concise description of what you want to happen.
Explain why you think this feature would be useful.
-->

0 comments on commit d3207e0

Please sign in to comment.