From 6c1a0bc95426664a32adc040768cd28fdcd421f6 Mon Sep 17 00:00:00 2001 From: Nick Bolton Date: Tue, 16 Jul 2024 08:58:17 +0100 Subject: [PATCH] Use YAML for bug report issue template (#7392) * Replace old bug report form * Add placeholders --- .github/ISSUE_TEMPLATE/bug_report.md | 88 ----------------- .github/ISSUE_TEMPLATE/bug_report.yml | 135 ++++++++++++++++++++++++++ 2 files changed, 135 insertions(+), 88 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index d882b388b..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: Replace with a short title that explains your bug simply -labels: bug, triage -assignees: '' - ---- - -### Operating Systems ### - ----BEGIN HELP--- - -Remember: Delete the help text (between `---BEGIN HELP---` and `---END HELP---`). -Technical support: https://symless.com/contact/customer-support?help-option=GitHub - -For example: - -Server: niceOS 10.42 -Client: Awesome XP SP13 - -Please distinguish which operating system is the client and which is the server. The server is the computer that the mouse and keyboard are shared from. - ----END HELP--- - -### Synergy Version ### - ----BEGIN HELP--- - -If you're not using the latest version of Synergy, please update first: -https://symless.com/synergy/downloads - -Please don't rely on Linux package manager versioning, they often get it wrong. If using the command line, you can use the `--version` arg to get your installed Synergy version, like so: - -Synergy 1: `synergys --version` -Synergy 2: `synergy-core --server --version` - -If you're using the Synergy 1 config app (main Synergy app) then go to the Help menu, and click About. In Synergy 2 Beta, the version is displayed at all times. - ----END HELP--- - -### Steps to Reproduce ### - ----BEGIN HELP--- - -This is the most important part. Try to remember exactly what exact steps caused the bug. Please make sure the steps are numbered and concise, like so: - -1. Do a little dance -2. Make a little love -3. Get down tonight - -Expected: Awesome things to happen -Actual: Not so awesome things happened - -Before submitting, try to reproduce the bug based on the steps you provided. - ----END HELP--- - -### Log URLs ### - -# README & DELETE # - ----BEGIN HELP--- - -Please do not paste entire logs here, it looks really silly. Instead, upload your logs, and share the URLs to the uploaded logs. Here's how you that: - -Synergy 1: https://symless.com/help/s1-troubleshooting/s1-sending-logs -Synergy 2: https://symless.com/help/s2-troubleshooting/s2-sending-logs - -Make sure you say which log is for which computer, and also which computer is the client and which one is the server. This helps to avoid any confusion. - ----END HELP--- - -### Extra Info ### - -# README & DELETE # - ----BEGIN HELP--- - -* Attach any screenshots -* What maybe causing it? -* Are there any workarounds? -* What other apps are you running? -* Does it stop you using Synergy entirely? -* Did restarting Synergy or the computer help? -* Is there anything else you can think of - ----END HELP--- diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..854e92a8c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,135 @@ +name: Bug Report +labels: ["bug", "triage"] +body: + - type: markdown + attributes: + value: Thanks for taking the time to help us improve Synergy. + + - type: checkboxes + id: discussion + attributes: + label: Discussion + description: | + Have you considered starting a discussion instead of reporting a bug? + options: + - label: Yes, and I still want to report a bug + required: true + + - type: dropdown + id: user-type + attributes: + label: What kind of user are you? + description: This will help us understand the context of your issue. + options: + - Customer + - Contributor + - Community user + default: 0 + + - type: input + id: ticket-number + attributes: + label: Support ticket number + description: | + Customers only (non-customers please ignore this field). + If you have a support ticket number, please enter it here. + Customers are advised to (open a support ticket)[https://symless.com/synergy/contact] + before submitting a bug report. + Leave this blank if you do not have a support ticket or if you're not a customer. + validations: + required: false + + - type: input + id: version + attributes: + label: Version number + description: You can find the Synergy version number on the about screen. + placeholder: 1.2.3 + validations: + required: true + + - type: checkboxes + id: os + attributes: + label: Operating systems + description: Which operating systems (OS) are you using? + options: + - value: Windows + - value: macOS + - value: Linux or Unix + - value: Other + + - type: textarea + id: os-version + attributes: + label: OS versions or Linux distros + description: | + Please provide the version number of your operating system. + If you're using Linux, please provide the name of the distribution. + placeholder: Windows 11, macOS 15, Ubuntu 24.04 + validations: + required: true + + - type: textarea + id: config + attributes: + label: Configuration + description: | + Please provide a very brief description of your configuration. + Let us know the OS of the server/host/primary and the OS of the client/guest/secondary. + This will help us understand how you're using Synergy. + placeholder: | + Windows 11 server, macOS 15 client + Each computer has a single monitor + Windows is on the left, macOS is on the right + + - type: textarea + id: repro-steps + attributes: + label: What steps will reproduce the problem? + description: | + Please list the steps to reproduce the issue. + If you're not sure, please provide as much detail as possible. + This will help us understand the problem. + placeholder: | + 1. Start Synergy + 2. Click 'Configure Server' + 3. Click 'Apply' + validations: + required: true + + - type: dropdown + id: product + attributes: + label: Product + description: Which product are you using? + options: + - Synergy 1 + - Synergy 2 + - Synergy 3 + default: 0 + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Log output + description: | + Please copy and paste any relevant log output. + This will be automatically formatted into code, so no need for backticks. + render: shell + + - type: textarea + id: additional-info + attributes: + label: Additional information + description: | + Please provide any additional information that may help us understand the issue. + This could include screenshots, error messages, or anything else you think is relevant. + - Any ideas about what maybe causing the problem? + - Any workarounds that you've discovered? + - What other apps are you running? + - Does the issue stop you using Synergy entirely? + - Did restarting Synergy or the computer help? + - Anything else you can think of?