From ea1b2808df2b711cb79bef43e0750ee281385576 Mon Sep 17 00:00:00 2001 From: Nick Bolton Date: Tue, 14 May 2019 12:15:22 +0100 Subject: [PATCH] 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.