From ea1b2808df2b711cb79bef43e0750ee281385576 Mon Sep 17 00:00:00 2001 From: Nick Bolton Date: Tue, 14 May 2019 12:15:22 +0100 Subject: [PATCH 1/3] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 104 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++ 2 files changed, 124 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..0854e9fa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,104 @@ +--- +name: Bug report +about: Create a report to help us improve +title: Client goes crazy when I mash the keyboard +labels: bug +assignees: '' + +--- + +### Operating Systems ### + +# README & DELETE # + +---BEGIN HELP--- + +For example: + +Server: exampleOS 10.13 +Client: Foobar XP + +Note: Please use this issue tracker only for raising bugs. + +- Feature requests: https://symless.com/forums/forum/18-feature-ideas/ +- Technical support: https://symless.com/contact/customer-support?help-option=GitHub + +It's very important that you 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. + +Remember: Delete the `# README & DELETE #` sections (including `---BEGIN HELP---` and +`---END HELP---`). + +---END HELP--- + +### Synergy Version ### + +# README & DELETE # + +---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 sometimes 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 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/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..d9bcafa8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: Make beep sound when moving from client to server +labels: enhancement +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. From 4050903db756c6d9f22cc2c34e34e4ea2436868c Mon Sep 17 00:00:00 2001 From: Nick Bolton Date: Tue, 14 May 2019 12:18:01 +0100 Subject: [PATCH 2/3] Update issue templates --- .github/ISSUE_TEMPLATE/feature_request.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index d9bcafa8..a2c2daad 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,14 +7,15 @@ 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 [...] +### Problem ### -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +[A clear and concise description of what the problem is. ] -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +### Solution ### -**Additional context** -Add any other context or screenshots about the feature request here. +[A clear and concise description of what you want to happen.] + +### More Info ### + +- Describe alternatives you've considered +- Add any other context or screenshots about the feature request here From ca91902c6f0d9d46b993b382e703f180e9eff53a Mon Sep 17 00:00:00 2001 From: Nick Bolton Date: Tue, 14 May 2019 12:18:17 +0100 Subject: [PATCH 3/3] Delete ISSUE_TEMPLATE.md --- .github/ISSUE_TEMPLATE.md | 32 -------------------------------- 1 file changed, 32 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index b1f62c9b..00000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,32 +0,0 @@ -### Operating Systems ### - -Server: microOS Tiara -Client: Applesoft Windy OS 10 - -**READ ME, DELETE ME**: On Windows, hold the Windows key and press 'r', type 'winver' and hit return to get your OS version. On Mac, hit the Apple menu (top left of the screen) and check 'About this Mac'. Linux users... you know what you're using ;) - -### Synergy Version ### - -1.8.π - -**READ ME, DELETE ME**: Go to the 'Help' (on Windows) or 'Synergy' (on macOS) menu and then 'About Synergy' to check your version. Verify that you are using the same version across all of your machines, and that your issue still occurs with the latest release available at https://symless.com/account/login - -### Steps to reproduce bug ### - -**READ ME, DELETE ME**: Try to be succinct. If your bug is intermittent, try and describe what you're doing when it happens most. - -1. Click things. -2. Type things. -3. Bug occurs. -4. ... -5. Profit? - -### Other info ### - -* When did the problem start to occur? When I... -* Is there a way to work around it? No/Yes, you can... -* Does this bug prevent you from using Synergy entirely? Yes/No - -Please follow the link below to send us logs from both your server and client sides if it's appropriate. https://github.com/symless/synergy/wiki/Sending-logs - -Put anything else you can think of here.