From c20ed80dc473ae7476a9359a55f7ec2618eb62e2 Mon Sep 17 00:00:00 2001 From: Jakob Borg Date: Thu, 7 May 2020 13:23:00 +0200 Subject: [PATCH] github: Update issue templates (#6610) * github: Update issue templates * wip * wip --- .github/ISSUE_TEMPLATE.md | 42 ---------------------- .github/ISSUE_TEMPLATE/01-feature.md | 13 +++++++ .github/ISSUE_TEMPLATE/02-bug.md | 23 ++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++++ .github/SECURITY.md | 52 ++++------------------------ 5 files changed, 51 insertions(+), 87 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/01-feature.md create mode 100644 .github/ISSUE_TEMPLATE/02-bug.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 22b5721be..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,42 +0,0 @@ -### DO NOT REPORT SECURITY ISSUES IN THIS ISSUE TRACKER - -Instead, contact security@syncthing.net directly - see -https://syncthing.net/security.html for more information. - -### DO NOT POST SUPPORT REQUESTS OR GENERAL QUESTIONS IN THIS ISSUE TRACKER - -Please use the forum at https://forum.syncthing.net/ where a large number of -helpful people hang out. This issue tracker is for reporting bugs or feature -requests directly to the developers. Worst case you might get a short -"that's a bug, please report it on GitHub" response on the forum, in which -case we thank you for your patience and following our advice. :) - -### Please use the correct issue tracker - -If your problem relates to a Syncthing wrapper or [sub-project](https://github.com/syncthing) such as [Syncthing for Android](https://github.com/syncthing/syncthing-android/issues), [SyncTrayzor](https://github.com/canton7/synctrayzor) or the [documentation](https://github.com/syncthing/docs/issues), please use their respective issue trackers. - -### Does your log mention database corruption? - -If your Syncthing log reports panics because of database corruption it is most likely a fault with your system's storage or memory. Affected log entries will contain lines starting with `panic: leveldb`. You will need to delete the index database to clear this, by running `syncthing -reset-database`. - -### Please do post actual bug reports and feature requests. - -If your issue is a bug report, replace this boilerplate with a description -of the problem, being sure to include at least: - - - what happened, - - what you expected to happen instead, and - - any steps to reproduce the problem. - -Also fill out the version information below and add log output or -screenshots as appropriate. - -If your issue is a feature request, simply replace this template text in -its entirety. - -### Version Information - -Syncthing Version: v1.x.y -OS Version: Windows 7 / Ubuntu 14.04 / ... -Browser Version: (if applicable, for GUI issues) - diff --git a/.github/ISSUE_TEMPLATE/01-feature.md b/.github/ISSUE_TEMPLATE/01-feature.md new file mode 100644 index 000000000..f58fed7d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-feature.md @@ -0,0 +1,13 @@ +--- +name: Feature request +about: If you're just not sure how to do something, see "ask a question". +labels: enhancement, needs-triage +--- + +### Include required information + +Please be sure to include at least: + + - what problem your new feature would solve + - how or why you think it is generally useful (i.e., not just for you) + - what alternatives or workarounds you considered diff --git a/.github/ISSUE_TEMPLATE/02-bug.md b/.github/ISSUE_TEMPLATE/02-bug.md new file mode 100644 index 000000000..03299e018 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-bug.md @@ -0,0 +1,23 @@ +--- +name: Bug report +about: If you're actually looking for support, see "ask a question". +labels: bug, needs-triage +--- + +### Does your log mention database corruption? + +If your Syncthing log reports panics because of database corruption it is +most likely a fault with your system's storage or memory. Affected log +entries will contain lines starting with `panic: leveldb`. You will need to +delete the index database to clear this, by running `syncthing +-reset-database`. + +### Include required information + +Please be sure to include at least: + + - which version of Syncthing and what operating system you are using + - browser and version, if applicable + - what happened, + - what you expected to happen instead, and + - any steps to reproduce the problem. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..7d09e7591 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Ask a question + url: https://forum.syncthing.net/ + about: Ask questions, get support, and discuss with other community members. + - name: Android issues + url: https://github.com/syncthing/syncthing-android/issues/ + about: The Android app has its own issue tracker. diff --git a/.github/SECURITY.md b/.github/SECURITY.md index a58cc36eb..5fe75c716 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -1,48 +1,10 @@ ## Reporting a Vulnerability -If you believe that you've found a Syncthing-related security vulnerability, please report it by sending email to the address security@syncthing.net. The PGP key for security@syncthing.net (B683AD7B76CAB013) below can be used to send encrypted mail or to verify responses received from that address. +If you believe that you've found a Syncthing-related security vulnerability, +please report it by sending email to the address security@syncthing.net. The +[PGP key for security@syncthing.net +(B683AD7B76CAB013)](https://syncthing.net/security-key.txt) can be used to +send encrypted mail or to verify responses received from that address. -``` ------BEGIN PGP PUBLIC KEY BLOCK----- -Version: GnuPG v1 - -mQENBFShFlIBCACsW346HYskhKhxrdZMjyU5Ntsjvg6/ogqINDPoL10/oaIP0G+t -7zzC0K5Cq29ix43kNNLKTJNyPkdTeaJEcqslMUt6tovjHwoKJ073GP0W3KsNvBRg -ffCZOAexGfOsBSL9KHaYGK67Py3TFgtN1H/EmboU1arrLfAMrmqOip++EGqOxjse -gH0qk7Mk1TqEC5Xh3NGE7r1UobAlqdUv5E3v7U11NhAdP1zu/XZ/zvP5mwVQJMLv -iZyeWGliNI8nEeRjYw+S85f4gq7H2mgoeNBN4WwwK1hhz9qpvCsgPW3XqlExTPI4 -1vM4PxpiFIuF0zuy2OwsmjrpTCZeBscr4Tj5ABEBAAG0K1N5bmN0aGluZyBTZWN1 -cml0eSA8c2VjdXJpdHlAc3luY3RoaW5nLm5ldD6JATgEEwECACIFAlShFlICGwMG -CwkIBwMCBhUIAgkKCwQWAgMBAh4BAheAAAoJELaDrXt2yrATB1UH/jnnIa6DekCA -2V36N/2+pFSNLVWeoZQxZ9ne9S7WSubaoK4oCWiuChPSAy5hagnKnNA3a9wrz5iN -0hgCA88NnTU18biZW6HX8xWEd3dnY3fX1sG0XdHuKlFria8ByfcrbShf/CttXkEd -Y5qPHH9aLIMtksBS1MIsRYrOCHiLNYFCKlbjDDCGT3tuk/yaU7aBAFVPIag54afC -zZAIvTIgRruLWkNT/sSEJx9ekhJzO/+pXNbSSHwhoj5OJh7sQjZWwPzNazelk48R -+ku8VpB5Wxgk2MnJPf1RxF+7saBAaeAVZsJcPN+Jp7u9LCFelIRn1ISsHbhLhyqL -cPXqllltLCKJAhwEEAECAAYFAlShFlsACgkQSfWuwLzlJMcEpA//VvZYHGZgZMM0 -bBkYnjManYnJkHSQ2pHsjquSFH+fbfq2FxxTk/nQ/IAvBzt8NDTT3ylPOmsl4A8q -r8BxsRNENhU7zDQrKC5NtYUrzXhPGo8qfDwkeLyqd2msUvHn7EH3PNgiN2QaFWxE -21FqoXIpERKJRgRtv1SYZoMyNGjmT2hta1ZbwEfrPJnzjYhneoUGsRApG7p+uPqe -4LRpbG3Fa2vBm/UWUrOe+6jPzvMokjIJbdK0IjXamFAzwYW5fSZaFa94mR6L5f5m -X8Dhp66mBRTx7qk6ldEqptvaYGqihaWP1xbDaApQsGHQujtcBYGp+edlkabuW5h7 -stl/7QTFkEPqHT4ybxEX0rLoFUGq56WUlKp27z40keStaXMgfrsxJtkz66Xs8vU4 -7qZcLAcPsin+y0toqavtwtM/L7uCMu1yhbFRGJ+JL6saJAqzwS8l7r6E2R7OnVj1 -BdASgxx1TgzW6ZFW5p1Iy6mtpkBypsnp8s3UcP3GFRnQe9gi1EXHjzuZAUGafe4Q -juvJ8t8xIcQMFuAylNIVyXvIWJoehqsVY9EBgVtE4y1SRh8XTT3Tddn8ab5fl7uh -HWAY8cRlv6WIOhK8w8oroiYx0SID8jMeEwJBS4DL7qWtJMkDo8ZEJiB+Pkd963MX -05QXt33AvJJ9PmbGCHkcH7198tCmA+e5AQ0EVKEWUgEIAPGczHpa6NdxY0pm+tIp -btiA6gdPE70pJYgJTKX7siCQ2w770H3CBSKmqEXadr7WnfIgUYIDaSxadeGzB/Mn -3SHCYRCqbA7mwu2k4wNNvCEM0xZqFAvaDJ4avlZ5oiMT8IFHKsjC77nkhmfXaIGt -hn10H2MFADjvJYul7vR+Ghg1wGhTGWo2u7VVj9BI+AfvnWaouFI0cx2KNWEI/Ocj -z6jk8nmC3yOEFQECM/hF4lkAOv9CQUa8UcvAr31trzawmV1iSsKjmVZgqd0N4T8f -hUikqUPZGNCRcqEUffTzggIyGPbedFnZw9Di7o1xByxyTrZycemAVqaVGF+9nFLG -pccAEQEAAYkBHwQYAQIACQUCVKEWUgIbDAAKCRC2g617dsqwEzrjB/9q0T8A4XUE -p0g6xq86jhmh4jlEedxrfXUL3R6ejFtuKMThulxEP0xiQ7xLzBhOnvyxLCsVbjp8 -0JtJTVCq44UzUiIBuVNRoYG29uXuTUL2UtI27VhjFxMzLDwZL97tbGR6lzdM/+U5 -9PC+PIvS0yz13z2t3/x3KUOnBgxZnpy9h4AdKwjrNVtnQdGDXSKlJBLb57TFcS94 -f3roZ5Gpw3AWYSmSSiZWbhks2UNzYSQ84LAKlV1NkktO+qRc/pUqr6IxMjOKc7XP -e8u1Nst6fN3GNqZOV+jUYs/fqrJgp1TUWjNTuf22Rl0Idz7XLPJKYFh9W7T/4MbU -M7Q8GZuww1rk -=No/v ------END PGP PUBLIC KEY BLOCK----- -``` +You can read more about Syncthing security at +https://syncthing.net/security/.