Skip to content

Commit 2b6d23a

Browse files
v-einhoffstadt
v-ein
authored and
hoffstadt
committed
chore: Updated issue and PR templates. Issue templates now use GitHub forms syntax.
1 parent e253945 commit 2b6d23a

8 files changed

Lines changed: 208 additions & 127 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 0 additions & 71 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
name: Bug Report
2+
description: File a report for unexpected or broken behavior.
3+
labels: ["state: pending", "type: bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**Before opening a bug report, please:**
9+
- Search [existing issues](https://github.com/hoffstadt/DearPyGui/issues?q=is%3Aissue) (including closed ones) — your bug may already be known.
10+
- Check the [FAQ](https://github.com/hoffstadt/DearPyGui/discussions/categories/frequently-asked-questions-faq), [Wiki](https://github.com/hoffstadt/DearPyGui/wiki), and [online documentation](https://dearpygui.readthedocs.io/en/latest/index.html).
11+
- **FOR FIRST-TIME USERS' ISSUES**, please use the [Discord server](https://discord.gg/tyE7Gu4).
12+
- Remove all third-party libraries.
13+
- Confirm that the problem still exists with the **latest released version** of DearPyGui.
14+
- 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.
15+
16+
- type: input
17+
id: dpg_version
18+
attributes:
19+
label: "Dear PyGui version:"
20+
description: >
21+
To obtain it, run `python -c "import dearpygui; print(dearpygui.__version__)"` or `pip show dearpygui`.
22+
placeholder: "e.g. 2.2.1"
23+
validations:
24+
required: true
25+
26+
- type: input
27+
id: python_version
28+
attributes:
29+
label: "Python version:"
30+
description: >
31+
To obtain it, run `python --version`.
32+
Note: DearPyGui requires Python 3.8+.
33+
placeholder: "e.g. 3.11.4"
34+
validations:
35+
required: true
36+
37+
- type: input
38+
id: operating_system
39+
attributes:
40+
label: "Operating system:"
41+
placeholder: "e.g. Windows 11 22H2 or Ubuntu 22.04 LTS"
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: description
47+
attributes:
48+
label: "My issue/question:"
49+
description: "A clear and concise description of what the issue/question is. Please provide as much context as possible!"
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: steps
55+
attributes:
56+
label: "Steps to reproduce:"
57+
value: |
58+
1. Go to '...'
59+
2. Click on '....'
60+
3. Scroll down to '....'
61+
4. See error
62+
validations:
63+
required: true
64+
65+
- type: textarea
66+
id: expected
67+
attributes:
68+
label: "Expected behavior:"
69+
description: "What did you expect to happen?"
70+
validations:
71+
required: true
72+
73+
- type: textarea
74+
id: screenshots
75+
attributes:
76+
label: "Screenshots:"
77+
description: |
78+
If applicable, attach screenshots or a screen recording (GIF/video) to help illustrate the problem. You can drag and drop files directly into this field. Please remove "N/A" text if you insert any screenshots.
79+
# This is to prevent GitHub from inserting "No response" section - N/A reads better.
80+
# As soon as GitHub starts entirely omitting empty inputs from issue description,
81+
# we can remove the "value" and just let the Screenshots section disappear if the user
82+
# doesn't provide any.
83+
value: "N/A"
84+
validations:
85+
required: false
86+
87+
- type: textarea
88+
id: mcve
89+
attributes:
90+
label: "Standalone, minimal, complete and verifiable example:"
91+
description: |
92+
**Please provide the shortest self-contained Python script that recreates the issue.**
93+
Strip your code down to only what is necessary to trigger the bug.<br>
94+
**Anyone** should be able to **copy and paste** this code and recreate your issue.<br>
95+
Issues without a reproducible example may be closed.
96+
render: python
97+
placeholder: |
98+
import dearpygui.dearpygui as dpg
99+
100+
dpg.create_context()
101+
dpg.create_viewport(title="Bug Demo")
102+
dpg.setup_dearpygui()
103+
104+
with dpg.window(label="Bug Demo"):
105+
# minimal code that triggers the bug
106+
pass
107+
108+
dpg.show_viewport()
109+
dpg.start_dearpygui()
110+
dpg.destroy_context()
111+
validations:
112+
required: true
113+
114+
- type: markdown
115+
attributes:
116+
value: |
117+
**Last-chance checklist:**
118+
- I have read DearPyGui documentation,
119+
- I have checked FAQ and wiki articles for solution,
120+
- I have searched for similar issues and found none,
121+
- I have proof-read the description and it fully describes the problem.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Quick question? Discord!
4+
url: https://discord.gg/tyE7Gu4
5+
about: Dear PyGui community is more active on Discord than here. If you're asking a question rather than reporting a bug, head over to Discord for a quick answer.
6+
- name: Dear PyGui is in maintenance mode!
7+
url: https://github.com/hoffstadt/DearPyGui/discussions
8+
about: Read this wiki article if you're unaware of the maintenance-only status of this project.

‎.github/ISSUE_TEMPLATE/doc_change.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Documentation Improvement
2+
description: Suggest a doc change.
3+
labels: ["state: pending", "type: docs"]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
description: "A clear and concise description of what the improvement is. Please provide as much context as possible."
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
id: assets
15+
attributes:
16+
label: Necessary assets
17+
description: "Any assets to use in the documentation. You can drag and drop files directly into this field."
18+
value: |
19+
- [ ] Pictures
20+
- [ ] Code Sample
21+
- [ ] GIFs
22+
23+
validations:
24+
required: false

‎.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 0 additions & 26 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Feature Request
2+
description: Suggest a new feature or improvement.
3+
labels: ["state: pending", "type: improvement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**Before opening a feature request, please:**
9+
- Search [existing issues](https://github.com/hoffstadt/DearPyGui/issues?q=is%3Aissue) and [discussions](https://github.com/hoffstadt/DearPyGui/discussions) (including closed ones) for similar requests.
10+
- Be mindful of [The XY Problem](https://en.wikipedia.org/wiki/XY_problem): describe **what you are trying to accomplish**, not only the specific solution you have in mind. There may be a better or already-available approach.
11+
12+
- type: textarea
13+
id: description
14+
attributes:
15+
label: Description
16+
description: "A clear and concise description of what the problem is."
17+
placeholder: "e.g. I'm trying to build X. There is currently no way to do Y, which means I have to work around it by..."
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: solution
23+
attributes:
24+
label: Proposed solution
25+
description: "A clear and concise description of what you want to happen."
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives considered
33+
description: "Describe any alternative approaches, workarounds, or existing solutions you have already tried or considered."
34+
value: "N/A"
35+
validations:
36+
required: false
37+
38+
- type: textarea
39+
id: additional
40+
attributes:
41+
label: Additional context
42+
description: "Any other context, screenshots, links to related issues, or references that might help."
43+
value: "N/A"
44+
validations:
45+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
---
2-
name: Pull Request
3-
about: Create a pull request to help us improve
4-
title: ''
5-
assignees: ''
6-
7-
---
8-
9-
<!-- dont forget to use the reviewer settings to notify any required reviewers -->
10-
<!-- using "Closes #issue-number" will link and autoclose all issue that this pull fixes upon accepting pull request -->
1+
<!-- Don't forget to use the reviewer settings to notify any required reviewers. -->
2+
<!-- Using "Closes #issue-number" will link and autoclose an issue that this pull fixes upon accepting the pull request. If you want to close multiple issues, type "closes" or "fixes" in front of each number (e.g. "closes #123, closes #456"). -->
113

124
**Description:**
135
<!-- A clear and concise description of what the pull request contains. -->
146

157
**Concerning Areas:**
168
<!--A clear and concise description of any concerning areas that may need extra attention during the pull request.-->
9+
10+
**A checklist on final steps:**
11+
12+
I confirm that I have:
13+
- [ ] listed all necessary tickets in with the "closes" keyword,
14+
- [ ] added reviewers,
15+
- [ ] proof-read the description in the Preview tab,
16+
- [ ] removed this checklist from PR description :) (yes, this checklist is for *you*, not for us - use it as a reminder).

0 commit comments

Comments
 (0)