From 378ac4880c9c1e2f1120ffdbc60083e456739b7a Mon Sep 17 00:00:00 2001 From: Chenlei Hu Date: Sat, 2 Aug 2025 22:49:53 -0400 Subject: [PATCH] [improve] Streamline GitHub issue templates for better UX (#4657) --- .github/ISSUE_TEMPLATE/bug-report.yaml | 157 ++++++++++---------- .github/ISSUE_TEMPLATE/feature-request.yaml | 74 ++++++--- 2 files changed, 139 insertions(+), 92 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index 4c8868d00..d4a309bf8 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -1,99 +1,106 @@ name: Bug Report -description: 'Something is not behaving as expected.' +description: 'Report something that is not working correctly' title: '[Bug]: ' labels: ['Potential Bug'] type: Bug body: - - type: markdown - attributes: - value: | - Before submitting a **Bug Report**, please ensure the following: - - - **1:** You are running the latest version of ComfyUI. - - **2:** You have looked at the existing bug reports and made sure this isn't already reported. - - type: checkboxes - id: custom-nodes-test attributes: - label: Custom Node Testing - description: Please confirm you have tried to reproduce the issue with all custom nodes disabled. + label: Prerequisites options: - - label: I have tried disabling custom nodes and the issue persists (see [how to disable custom nodes](https://docs.comfy.org/troubleshooting/custom-node-issues#step-1%3A-test-with-all-custom-nodes-disabled) if you need help) + - label: I am running the latest version of ComfyUI + required: true + - label: I have searched existing issues to make sure this isn't a duplicate + required: true + - label: I have tested with all custom nodes disabled ([see how](https://docs.comfy.org/troubleshooting/custom-node-issues#step-1%3A-test-with-all-custom-nodes-disabled)) required: true - type: textarea + id: description attributes: - label: Frontend Version - description: | - What is the frontend version you are using? You can check this in the settings dialog. - -
- - Click to show where to find the version - - Open the setting by clicking the cog icon in the bottom-left of the screen, then click `About`. - - ![Frontend version](https://github.com/user-attachments/assets/561fb7c3-3012-457c-a494-9bdc1ff035c0) - -
- 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.' + label: What happened? + description: A clear and concise description of the bug. Include screenshots or videos if helpful. + placeholder: | + Example: "When I connect a VAE Decode node to a KSampler, the connection line appears but the workflow fails to execute with an error message..." validations: required: true + - type: textarea + id: reproduce 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.' - render: powershell - validations: - required: true - - type: textarea - attributes: - label: Browser Logs - description: 'Please copy the output from your browser logs here. You can access this by pressing F12 to toggle the developer tools, then navigating to the Console tab.' - validations: - required: true - - type: textarea - attributes: - label: Setting JSON - description: 'Please upload the setting file here. The setting file is located at `user/default/comfy.settings.json`' + description: How can we reproduce this issue? Please attach your workflow (JSON or PNG). + placeholder: | + 1. Add a KSampler node + 2. Connect it to... + 3. Click Queue Prompt + 4. See error + value: | + 1. + 2. + 3. validations: required: true + - type: dropdown - id: browsers + id: severity attributes: - label: What browsers do you use to access the UI ? - multiple: true + label: How is this affecting you? options: - - Mozilla Firefox - - Google Chrome - - Brave - - Apple Safari - - Microsoft Edge - - Android - - iOS - - Other - - type: textarea - attributes: - label: Other Information - description: 'Any other context, details, or screenshots that might help solve the issue.' - placeholder: 'Add any other relevant information here...' + - Crashes ComfyUI completely + - Workflow won't execute + - Feature doesn't work as expected + - Visual/UI issue only + - Minor inconvenience validations: - required: false + required: true + + - type: input + id: version + attributes: + label: ComfyUI Frontend Version + description: Found in Settings > About (e.g., "1.3.45") + placeholder: "1.3.45" + validations: + required: true + + - type: dropdown + id: browser + attributes: + label: Browser + description: Which browser are you using? + options: + - Chrome/Chromium + - Firefox + - Safari + - Edge + - Other + validations: + required: true + + - type: markdown + attributes: + value: | + ## Additional Information (Optional) + *The following fields help us debug complex issues but are not required for most bug reports.* + + - type: textarea + id: console-errors + attributes: + label: Console Errors + description: If you see red error messages in the browser console (F12), paste them here + render: javascript + + - type: textarea + id: logs + attributes: + label: Logs + description: If relevant, paste any terminal/server logs here + render: shell + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Any other information that might help (OS, GPU, specific nodes involved, etc.) diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml index dc1667a6f..a32598374 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yaml +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -1,6 +1,6 @@ name: Feature Request -description: Suggest an idea for this project -title: '[Feature Request]: ' +description: Report a problem or limitation you're experiencing +title: '[Feature]: ' labels: ['enhancement'] type: Feature @@ -8,34 +8,74 @@ body: - type: checkboxes attributes: label: Is there an existing issue for this? - description: Please search to see if an issue already exists for the feature you want, and that it's not implemented in a recent build/commit. + description: Please search to see if an issue already exists for the problem you're experiencing, and that it's not addressed in a recent build/commit. options: - label: I have searched the existing issues and checked the recent builds/commits 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* + *Please focus on describing the problem you're experiencing rather than proposing specific solutions. This helps us design the best possible solution for you and other users.* - type: textarea - id: feature + id: problem attributes: - label: What would your feature do ? - description: Tell us about your feature in a very clear and simple way, and what problem it would solve + label: What problem are you experiencing? + description: Describe the issue or limitation you're facing in your workflow + placeholder: | + Example: "I frequently lose work when switching between different projects because there's no way to save my current workspace state" + NOT: "Add a save button that exports the workspace" validations: required: true - type: textarea - id: workflow + id: context attributes: - label: Proposed 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. ... + label: When does this problem occur? + description: Describe the specific situations or workflows where you encounter this issue + placeholder: | + - When working with large node graphs... + - During batch processing workflows... + - While collaborating with team members... + validations: + required: true + - type: dropdown + id: frequency + attributes: + label: How often do you encounter this problem? + options: + - Multiple times per day + - Daily + - Several times per week + - Weekly + - Occasionally + - Rarely + validations: + required: true + - type: dropdown + id: impact + attributes: + label: How much does this problem affect your workflow? + description: Help us understand the severity of this issue for you + options: + - Blocks me from completing tasks + - Significantly slows down my work + - Causes moderate inconvenience + - Minor annoyance validations: required: true - type: textarea - id: misc + id: workaround attributes: - label: Additional information - description: Add any other context or screenshots about the feature request here. + label: Current workarounds + description: How do you currently deal with this problem, if at all? + placeholder: | + Example: "I manually export and reimport nodes between projects, which takes 10-15 minutes each time" + - type: textarea + id: ideas + attributes: + label: Ideas for solutions (Optional) + description: If you have thoughts on potential solutions, feel free to share them here. However, we'll explore all possible options to find the best approach. + - type: textarea + id: additional + attributes: + label: Additional context + description: Add any other context, screenshots, or examples that help illustrate the problem.