Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 0 additions & 71 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

121 changes: 121 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
name: Bug Report
description: File a report for unexpected or broken behavior.
labels: ["state: pending", "type: bug"]
body:
- type: markdown
attributes:
value: |
**Before opening a bug report, please:**
- Search [existing issues](https://github.com/hoffstadt/DearPyGui/issues?q=is%3Aissue) (including closed ones) — your bug may already be known.
- 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).
- **FOR FIRST-TIME USERS' ISSUES**, please use the [Discord server](https://discord.gg/tyE7Gu4).
- Remove all third-party libraries.
- Confirm that the problem still exists with the **latest released version** of DearPyGui.
- 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: input
id: dpg_version
attributes:
label: "Dear PyGui version:"
description: >
To obtain it, run `python -c "import dearpygui; print(dearpygui.__version__)"` or `pip show dearpygui`.
placeholder: "e.g. 2.2.1"
validations:
required: true

- type: input
id: python_version
attributes:
label: "Python version:"
description: >
To obtain it, run `python --version`.
Note: DearPyGui requires Python 3.8+.
placeholder: "e.g. 3.11.4"
validations:
required: true

- type: input
id: operating_system
attributes:
label: "Operating system:"
placeholder: "e.g. Windows 11 22H2 or Ubuntu 22.04 LTS"
validations:
required: true

- type: textarea
id: description
attributes:
label: "My issue/question:"
description: "A clear and concise description of what the issue/question is. Please provide as much context as possible!"
validations:
required: true

- type: textarea
id: steps
attributes:
label: "Steps to reproduce:"
value: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true

- type: textarea
id: expected
attributes:
label: "Expected behavior:"
description: "What did you expect to happen?"
validations:
required: true

- type: textarea
id: screenshots
attributes:
label: "Screenshots:"
description: |
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.
# This is to prevent GitHub from inserting "No response" section - N/A reads better.
# As soon as GitHub starts entirely omitting empty inputs from issue description,
# we can remove the "value" and just let the Screenshots section disappear if the user
# doesn't provide any.
value: "N/A"
validations:
required: false

- type: textarea
id: mcve
attributes:
label: "Standalone, minimal, complete and verifiable example:"
description: |
**Please provide the shortest self-contained Python script that recreates the issue.**
Strip your code down to only what is necessary to trigger the bug.<br>
**Anyone** should be able to **copy and paste** this code and recreate your issue.<br>
Issues without a reproducible example may be closed.
render: python
placeholder: |
import dearpygui.dearpygui as dpg

dpg.create_context()
dpg.create_viewport(title="Bug Demo")
dpg.setup_dearpygui()

with dpg.window(label="Bug Demo"):
# minimal code that triggers the bug
pass

dpg.show_viewport()
dpg.start_dearpygui()
dpg.destroy_context()
validations:
required: true

- type: markdown
attributes:
value: |
**Last-chance checklist:**
- I have read DearPyGui documentation,
- I have checked FAQ and wiki articles for solution,
- I have searched for similar issues and found none,
- I have proof-read the description and it fully describes the problem.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Quick question? Discord!
url: https://discord.gg/tyE7Gu4
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.
- name: Dear PyGui is in maintenance mode!
url: https://github.com/hoffstadt/DearPyGui/discussions
about: Read this wiki article if you're unaware of the maintenance-only status of this project.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/doc_change.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Documentation Improvement
description: Suggest a doc change.
labels: ["state: pending", "type: docs"]
body:
- type: textarea
id: description
attributes:
label: Description
description: "A clear and concise description of what the improvement is. Please provide as much context as possible."
validations:
required: true

- type: textarea
id: assets
attributes:
label: Necessary assets
description: "Any assets to use in the documentation. You can drag and drop files directly into this field."
value: |
- [ ] Pictures
- [ ] Code Sample
- [ ] GIFs

validations:
required: false
26 changes: 0 additions & 26 deletions .github/ISSUE_TEMPLATE/documentation.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Feature Request
description: Suggest a new feature or improvement.
labels: ["state: pending", "type: improvement"]
body:
- type: markdown
attributes:
value: |
**Before opening a feature request, please:**
- 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.
- 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.

- type: textarea
id: description
attributes:
label: Description
description: "A clear and concise description of what the problem is."
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..."
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed solution
description: "A clear and concise description of what you want to happen."
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: "Describe any alternative approaches, workarounds, or existing solutions you have already tried or considered."
value: "N/A"
validations:
required: false

- type: textarea
id: additional
attributes:
label: Additional context
description: "Any other context, screenshots, links to related issues, or references that might help."
value: "N/A"
validations:
required: false
20 changes: 10 additions & 10 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
name: Pull Request
about: Create a pull request to help us improve
title: ''
assignees: ''

---

<!-- dont forget to use the reviewer settings to notify any required reviewers -->
<!-- using "Closes #issue-number" will link and autoclose all issue that this pull fixes upon accepting pull request -->
<!-- Don't forget to use the reviewer settings to notify any required reviewers. -->
<!-- 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"). -->

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

**Concerning Areas:**
<!--A clear and concise description of any concerning areas that may need extra attention during the pull request.-->

**A checklist on final steps:**

I confirm that I have:
- [ ] listed all necessary tickets in with the "closes" keyword,
- [ ] added reviewers,
- [ ] proof-read the description in the Preview tab,
- [ ] removed this checklist from PR description :) (yes, this checklist is for *you*, not for us - use it as a reminder).
Loading