Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Github issue templates #352

Merged
merged 4 commits into from
Nov 26, 2024
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
88 changes: 88 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
name: Bug Report
description: "Something is not behaving as expected."
title: "[Bug]: "
labels: ['Potential Bug']
body:
- type: markdown
attributes:
value: |
Before submitting a **Bug Report**, please ensure the following:

- **1:** You have looked at the existing bug reports and made sure this isn't already reported.
- **2:** You confirmed that the bug is not caused by a custom node. You can disable all custom nodes in Server-Config
Panel.
![ServerConfigPanel](https://github.com/user-attachments/assets/dcda1a24-c8bf-428d-b89d-f3cde3d1b435)


- type: textarea
attributes:
label: App Version
description: |
What is the version you are using? You can check this in the settings dialog
![AboutPanel](https://github.com/user-attachments/assets/76278cde-a60f-45fe-aaf1-fd17930655c0)
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: 'What you expected to happen.'
validations:
required: true
- type: textarea
attributes:
label: Actual Behavior
description: 'What actually happened. Please include a screenshot / video clip of the issue if possible.'
validations:
required: true
- type: textarea
attributes:
label: Steps to Reproduce
description: "Describe how to reproduce the issue. Please be sure to attach a workflow JSON or PNG, ideally one that doesn't require custom nodes to test. If the bug open happens when certain custom nodes are used, most likely that custom node is what has the bug rather than ComfyUI, in which case it should be reported to the node's author."
validations:
required: true
- type: textarea
attributes:
label: Debug Logs
description: |
Please copy the output from your terminal logs here.
![DebugLogs](https://github.com/user-attachments/assets/168b6ea3-ab93-445b-9cd2-670bd9c098a7)
render: powershell
validations:
required: true
- type: textarea
attributes:
label: Browser Logs
description: |
Please copy the output from your browser logs here.
![OpenDevTools](https://github.com/user-attachments/assets/4505621e-34f0-4b66-b9d0-2e1a9133a635)
![ConsoleTab](https://github.com/user-attachments/assets/cc96c0db-2880-40bb-93a2-c035360c41b2)
validations:
required: true
- type: textarea
attributes:
label: Setting JSON
description: |
Please upload the setting file here. Follow following screenshot to open model directory. The setting file is located at `../user/default/comfy.settings.json`
![OpenFolder](https://github.com/user-attachments/assets/254e41c7-6335-4d6a-a7dd-c93ab74a9d5e)
validations:
required: true
- type: dropdown
id: browsers
attributes:
label: What browsers do you use to access the UI ?
multiple: true
options:
- Mozilla Firefox
- Google Chrome
- Brave
- Apple Safari
- Microsoft Edge
- Android
- iOS
- Other
- type: textarea
attributes:
label: Other
description: 'Any other additional information you think might be helpful.'
validations:
required: false
84 changes: 84 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
name: Feature Request
description: Suggest an idea for this project
title: "[Feature Request]: "
labels: ["enhancement"]

body:
- type: checkboxes
attributes:
label: Prerequisites
description: Please ensure you've completed these steps before submitting a feature request
options:
- label: I have searched the existing issues and checked the recent builds/commits
required: true
- label: I have read the documentation and this feature is not already available
required: true
- label: This is a single feature request (not multiple features combined)
required: true
- type: markdown
attributes:
value: |
*Please fill this form with as much information as possible, provide screenshots and/or illustrations of the feature if possible*
- type: textarea
id: problem
attributes:
label: Problem Statement
description: What problem are you trying to solve? Please describe the issue you're facing.
placeholder: |
Example:
- I'm frustrated when...
- I find it difficult to...
- I wish I could...
validations:
required: true
- type: textarea
id: feature
attributes:
label: Proposed Solution
description: Describe your suggested feature and how it solves the problem
placeholder: |
Example:
- Add a button that...
- Implement a system for...
- Create a new option to...
validations:
required: true
- type: textarea
id: workflow
attributes:
label: Potential workflow
description: Please provide us with step by step information on how you'd like the feature to be accessed and used
value: |
1. Go to ....
2. Press ....
3. ...
validations:
required: true
- type: dropdown
id: impact
attributes:
label: Impact Level
description: How would you rate the impact of this feature?
options:
- Critical (Blocking my work)
- High (Major improvement)
- Medium (Nice to have)
- Low (Minor enhancement)
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: What alternative solutions have you considered?
placeholder: |
Example:
- Tried using X instead, but...
- Considered Y approach, however...
validations:
required: false
- type: textarea
id: misc
attributes:
label: Additional information
description: Add any other context or screenshots about the feature request here.
Loading