From fd1008f1e0f067a99793c7885e1f5010811f1ac0 Mon Sep 17 00:00:00 2001 From: Leo Mozoloa Date: Sun, 16 Oct 2022 12:41:03 +0200 Subject: Better Bug report form --- .github/ISSUE_TEMPLATE/bug_report.md | 32 ------------------ .github/ISSUE_TEMPLATE/bug_report.yml | 61 +++++++++++++++++++++++++++++++++++ 2 files changed, 61 insertions(+), 32 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 50c54210..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug-report -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. Windows, Linux] - - Browser [e.g. chrome, safari] - - Commit revision [looks like this: e68484500f76a33ba477d5a99340ab30451e557b; can be seen when launching webui.bat, or obtained manually by running `git rev-parse HEAD`] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..9b7e224e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,61 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["bug-report"] + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: what-did + attributes: + label: What did happened? + description: Also tell us, what did you expect to happen? + validations: + required: true + - type: textarea + id: what-should + attributes: + label: What should have happened? + description: tell what you think the normal behavior should be + validations: + required: true + - type: textarea + id: commit + attributes: + label: commit + description: Which commit are you running ? (copy the **Commit hash** shown in the cmd/terminal when you launch the UI) + - type: dropdown + id: browsers + attributes: + label: What browsers do you use to run the UI ? + multiple: true + options: + - Mozilla Firefox + - Google Chrome + - Brave + - Apple Safari + - Microsoft Edge + - type: dropdown + id: os + attributes: + label: Where are you running the webui? + multiple: true + options: + - Colab/Cloud + - Windows + - Linux + - MacOS + - type: textarea + id: cmdargs + attributes: + label: Command Line Arguments + description: Are you using any launching parameters/command line arguments (modified webui-user.py) ? If yes, please write them below + render: Shell + - type: textarea + id: misc + attributes: + label: Additionnal information, context and logs + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. -- cgit v1.2.1 From d0042587adf03059977181fae9c2ede019044fe0 Mon Sep 17 00:00:00 2001 From: Leo Mozoloa Date: Sun, 16 Oct 2022 12:46:36 +0200 Subject: Cleaning & improvements --- .github/ISSUE_TEMPLATE/bug_report.yml | 26 +++++++++++--------------- 1 file changed, 11 insertions(+), 15 deletions(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 9b7e224e..02fc994c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -4,10 +4,6 @@ title: "[Bug]: " labels: ["bug-report"] body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this bug report! - type: textarea id: what-did attributes: @@ -25,8 +21,18 @@ body: - type: textarea id: commit attributes: - label: commit + label: Commit where the problem happens description: Which commit are you running ? (copy the **Commit hash** shown in the cmd/terminal when you launch the UI) + - type: dropdown + id: os + attributes: + label: What OS do you use to run the webui? + multiple: true + options: + - Colab/Runpod or Cloud based + - Windows + - Linux + - MacOS - type: dropdown id: browsers attributes: @@ -38,16 +44,6 @@ body: - Brave - Apple Safari - Microsoft Edge - - type: dropdown - id: os - attributes: - label: Where are you running the webui? - multiple: true - options: - - Colab/Cloud - - Windows - - Linux - - MacOS - type: textarea id: cmdargs attributes: -- cgit v1.2.1 From dd66530a63f47aa87f4a95eaece51052d45a29f0 Mon Sep 17 00:00:00 2001 From: Leo Mozoloa Date: Sun, 16 Oct 2022 12:53:36 +0200 Subject: Fixes and adding step by step --- .github/ISSUE_TEMPLATE/bug_report.yml | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 02fc994c..3243f934 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -7,8 +7,18 @@ body: - type: textarea id: what-did attributes: - label: What did happened? - description: Also tell us, what did you expect to happen? + label: What happened? + description: Tell us what happened in a very clear and simple way + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to reproduce the problem + description: Please provide us with precise step by step information to reproduce the bug + value: 1. Go to .... | + 2. Press .... + 3. ... validations: required: true - type: textarea @@ -18,7 +28,7 @@ body: description: tell what you think the normal behavior should be validations: required: true - - type: textarea + - type: input id: commit attributes: label: Commit where the problem happens -- cgit v1.2.1 From 45f188e0d3167f36c69bdf392a1141b8e5183d21 Mon Sep 17 00:00:00 2001 From: Leo Mozoloa Date: Sun, 16 Oct 2022 12:54:43 +0200 Subject: fixing linebreak issue --- .github/ISSUE_TEMPLATE/bug_report.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 3243f934..55fb2d72 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -16,7 +16,8 @@ body: attributes: label: Steps to reproduce the problem description: Please provide us with precise step by step information to reproduce the bug - value: 1. Go to .... | + value: | + 1. Go to .... 2. Press .... 3. ... validations: -- cgit v1.2.1 From 03cf7cf32798d45ae92832bd22bea8b299e64a17 Mon Sep 17 00:00:00 2001 From: Leo Mozoloa Date: Sun, 16 Oct 2022 13:00:28 +0200 Subject: Fixes and trying to make dropdown required --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 55fb2d72..201ed57d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -15,7 +15,7 @@ body: id: steps attributes: label: Steps to reproduce the problem - description: Please provide us with precise step by step information to reproduce the bug + description: Please provide us with precise step by step information on how to reproduce the bug value: | 1. Go to .... 2. Press .... @@ -44,6 +44,7 @@ body: - Windows - Linux - MacOS + required: true - type: dropdown id: browsers attributes: @@ -55,6 +56,7 @@ body: - Brave - Apple Safari - Microsoft Edge + required: true - type: textarea id: cmdargs attributes: -- cgit v1.2.1 From ca30e67289f9e2d0aca33c9da8d915ae3bcc39cc Mon Sep 17 00:00:00 2001 From: Leo Mozoloa Date: Sun, 16 Oct 2022 13:03:03 +0200 Subject: removing the required tag as it obviously doesn't work, adding a top description --- .github/ISSUE_TEMPLATE/bug_report.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 201ed57d..b53db6bb 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -4,6 +4,10 @@ title: "[Bug]: " labels: ["bug-report"] body: + - type: markdown + attributes: + value: | + Please fill this form with as much information as possible, don't forget to fill "What OS..." and "What browsers" - type: textarea id: what-did attributes: @@ -44,7 +48,6 @@ body: - Windows - Linux - MacOS - required: true - type: dropdown id: browsers attributes: @@ -56,7 +59,6 @@ body: - Brave - Apple Safari - Microsoft Edge - required: true - type: textarea id: cmdargs attributes: -- cgit v1.2.1 From 8400e854747970ee1593619c37736c47cdac7e3e Mon Sep 17 00:00:00 2001 From: Leo Mozoloa Date: Sun, 16 Oct 2022 13:13:22 +0200 Subject: Adding a confirmation checkbox that the user has checked the issues & commits before Also small fixes --- .github/ISSUE_TEMPLATE/bug_report.yml | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index b53db6bb..3e8732f9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,13 +1,20 @@ name: Bug Report -description: File a bug report +description: You think somethings is broken in the UI title: "[Bug]: " -labels: ["bug-report"] +labels: ["bug"] body: - type: markdown attributes: value: | - Please fill this form with as much information as possible, don't forget to fill "What OS..." and "What browsers" + Make sure this issue hasn't been posted already and wasn't solved in recent commits, then fill this form with as much information as possible, don't forget to fill "What OS..." and "What browsers" + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered, and that it hasn't been fixed in a recent build/commit. + options: + - label: I have searched the existing issues and checked the recent builds/commits + required: true - type: textarea id: what-did attributes: -- cgit v1.2.1 From 62a1a97fe3e1b322e2a1c6a1fcc0272e9b132704 Mon Sep 17 00:00:00 2001 From: Leo Mozoloa Date: Sun, 16 Oct 2022 13:22:35 +0200 Subject: Fixed labels and created a brand new Feature Request yaml --- .github/ISSUE_TEMPLATE/bug_report.yml | 10 ++++---- .github/ISSUE_TEMPLATE/feature_request.md | 20 --------------- .github/ISSUE_TEMPLATE/feature_request.yml | 40 ++++++++++++++++++++++++++++++ 3 files changed, 45 insertions(+), 25 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 3e8732f9..04f072bc 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,13 +1,9 @@ name: Bug Report description: You think somethings is broken in the UI title: "[Bug]: " -labels: ["bug"] +labels: ["bug-report"] body: - - type: markdown - attributes: - value: | - Make sure this issue hasn't been posted already and wasn't solved in recent commits, then fill this form with as much information as possible, don't forget to fill "What OS..." and "What browsers" - type: checkboxes attributes: label: Is there an existing issue for this? @@ -15,6 +11,10 @@ body: 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, don't forget to fill "What OS..." and "What browsers" and *provide screenshots if possible* - type: textarea id: what-did attributes: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index eda42fa7..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: 'suggestion' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..045e15da --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,40 @@ +name: Feature request +description: Suggest an idea for this project +title: "[Feature Request]: " +labels: ["suggestion"] + +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: Additionnal information + description: Add any other context or screenshots about the feature request here. -- cgit v1.2.1 From 5292d1f0920186e53ef2280637845c8344518a89 Mon Sep 17 00:00:00 2001 From: Leo Mozoloa Date: Sun, 16 Oct 2022 13:26:05 +0200 Subject: Formatting the top description --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 04f072bc..84053e76 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -14,7 +14,7 @@ body: - type: markdown attributes: value: | - Please fill this form with as much information as possible, don't forget to fill "What OS..." and "What browsers" and *provide screenshots if possible* + *Please fill this form with as much information as possible, don't forget to fill "What OS..." and "What browsers" and *provide screenshots if possible** - type: textarea id: what-did attributes: diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 045e15da..62133a0d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -14,7 +14,7 @@ body: - 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 fill this form with as much information as possible, provide screenshots and/or illustrations of the feature if possible* - type: textarea id: feature attributes: -- cgit v1.2.1 From 3e2a035ffaf6f45a18b971ee0388f5ddca312714 Mon Sep 17 00:00:00 2001 From: Leo Mozoloa Date: Sun, 16 Oct 2022 14:30:11 +0200 Subject: Removed obsolete legacy Hlky description --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 84053e76..629afad3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -76,4 +76,4 @@ body: id: misc attributes: label: Additionnal information, context and logs - description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + description: Please provide us with any relevant additional info, context or log output. -- cgit v1.2.1 From a0e50d5e70094dbdfd048efee566865ab93e4c3f Mon Sep 17 00:00:00 2001 From: Leo Mozoloa Date: Mon, 17 Oct 2022 19:09:06 +0200 Subject: Improved the OS/Platforms field --- .github/ISSUE_TEMPLATE/bug_report.yml | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 629afad3..d2edb250 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -46,19 +46,21 @@ body: label: Commit where the problem happens description: Which commit are you running ? (copy the **Commit hash** shown in the cmd/terminal when you launch the UI) - type: dropdown - id: os + id: platforms attributes: - label: What OS do you use to run the webui? + label: What platforms do you use to access UI ? multiple: true options: - - Colab/Runpod or Cloud based - Windows - Linux - MacOS + - iOS + - Android + - Other/Cloud - type: dropdown id: browsers attributes: - label: What browsers do you use to run the UI ? + label: What browsers do you use to access the UI ? multiple: true options: - Mozilla Firefox -- cgit v1.2.1 From 5d9e3acd4e8fc9562d0b2972e79f6cf8597d3805 Mon Sep 17 00:00:00 2001 From: Leo Mozoloa Date: Wed, 19 Oct 2022 19:38:38 +0200 Subject: Fixed additionnnnal typo, sorry --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index d2edb250..35802a53 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -77,5 +77,5 @@ body: - type: textarea id: misc attributes: - label: Additionnal information, context and logs + label: Additional information, context and logs description: Please provide us with any relevant additional info, context or log output. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 62133a0d..8ca6e21f 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -36,5 +36,5 @@ body: - type: textarea id: misc attributes: - label: Additionnal information + label: Additional information description: Add any other context or screenshots about the feature request here. -- cgit v1.2.1