From 500c27ac18c5643444bc2f20244973a3a454e7e8 Mon Sep 17 00:00:00 2001 From: huchenlei Date: Mon, 25 Nov 2024 14:12:00 -0500 Subject: [PATCH 1/4] WIP --- .github/ISSUE_TEMPLATE/bug-report.yaml | 78 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.yaml | 40 +++++++++++ 2 files changed, 118 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 00000000..15f7c6cb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,78 @@ +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. + + + - type: textarea + attributes: + label: Frontend Version + description: 'What is the frontend version you are using? You can check this in the settings dialog' + 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.' + 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`' + 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 diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml new file mode 100644 index 00000000..3ad7f49f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -0,0 +1,40 @@ +name: Feature Request +description: Suggest an idea for this project +title: "[Feature Request]: " +labels: ["enhancement"] + +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. + 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* + - type: textarea + id: feature + 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 + validations: + required: true + - type: textarea + id: workflow + 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. ... + validations: + required: true + - type: textarea + id: misc + attributes: + label: Additional information + description: Add any other context or screenshots about the feature request here. From 4c30d14c580853c2dad0e7c5d48d2ba2b7417783 Mon Sep 17 00:00:00 2001 From: huchenlei Date: Mon, 25 Nov 2024 19:14:15 -0500 Subject: [PATCH 2/4] Attach ScreenShots --- .github/ISSUE_TEMPLATE/bug-report.yaml | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index 15f7c6cb..1a4c8d62 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -11,12 +11,15 @@ body: - **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: Frontend Version - description: 'What is the frontend version you are using? You can check this in the settings dialog' + 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 @@ -40,20 +43,27 @@ body: - type: textarea attributes: label: Debug Logs - description: 'Please copy the output from your terminal logs here.' + 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. You can access this by pressing F12 to toggle the developer tools, then navigating to the Console tab.' + 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. The setting file is located at `user/default/comfy.settings.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 From 1f39c93e0bdc3f4f4a38cf781bbf759ed3d3a28a Mon Sep 17 00:00:00 2001 From: huchenlei Date: Mon, 25 Nov 2024 19:17:07 -0500 Subject: [PATCH 3/4] Expand feature request template --- .github/ISSUE_TEMPLATE/feature-request.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml index 3ad7f49f..38112c89 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yaml +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -18,14 +18,14 @@ body: - type: textarea id: feature attributes: - label: What would your feature do ? + label: What problem does this feature solve ? description: Tell us about your feature in a very clear and simple way, and what problem it would solve validations: required: true - type: textarea id: workflow attributes: - label: Proposed workflow + 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 .... From bdfa71b91fa620fc3f0d2a766c983f8b21b7028d Mon Sep 17 00:00:00 2001 From: huchenlei Date: Mon, 25 Nov 2024 19:17:19 -0500 Subject: [PATCH 4/4] Expand feature request template --- .github/ISSUE_TEMPLATE/feature-request.yaml | 52 +++++++++++++++++++-- 1 file changed, 48 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml index 38112c89..1567a168 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yaml +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -6,20 +6,41 @@ labels: ["enhancement"] 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. + 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: What problem does this feature solve ? - description: Tell us about your feature in a very clear and simple way, and what problem it would solve + 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 @@ -33,6 +54,29 @@ body: 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: