From 1e84d85330cd275c2f2cae35f7330a2a0d584748 Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Sun, 27 Mar 2022 13:20:27 +0200 Subject: [PATCH] Docs: Update "When to use GitHub Issues" in templates and README.md --- .github/ISSUE_TEMPLATE/bug_report.md | 10 +++++++++- .github/ISSUE_TEMPLATE/feature-request.md | 6 ++++++ CONTRIBUTING.md | 5 +++-- README.md | 5 +++-- 4 files changed, 21 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 13d4e678f..0c038f36a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,7 +7,8 @@ assignees: '' --- -IMPORTANT - PLEASE READ BEFORE PROCEEDING: +STOP! BEFORE YOU PROCEED: ARE YOU 100% SURE THAT THIS IS NOT A TECHNICAL SUPPORT REQUEST +AND/OR A PROBLEM WITH ANOTHER SOFTWARE YOU ARE USING, SUCH AS NGINX? - We kindly ask you not to report bugs via GitHub Issues **unless you are certain to have found a fully reproducible and previously unreported issue** that must be fixed directly in the app - When reporting a problem, **always include the software versions you are using and other information about your environment** such as browser, browser plugins, operating system, storage type, memory size, and processor @@ -27,6 +28,13 @@ FOR GENERAL QUESTIONS, TECHNICAL SUPPORT, AND TO GET TO KNOW OTHER COMMUNITY MEM +PLEASE PROCEED ONLY IF YOU ARE 100% SURE THAT THIS IS NOT A TECHNICAL SUPPORT REQUEST +AND/OR A PROBLEM WITH ANOTHER SOFTWARE YOU ARE USING. + +**THANK YOU FOR YOUR CAREFUL CONSIDERATION!** + +=============================================================================== + **What does not work as described in the documentation?** "No photos found" is not a sufficient description. Please be more specific and explain which part of the software has a bug and needs to be fixed. Do not report known issues or features not yet implemented as bugs. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 9dd98f10e..677ee3fd8 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -22,6 +22,12 @@ FOR GENERAL QUESTIONS, TECHNICAL SUPPORT, AND TO GET TO KNOW OTHER COMMUNITY MEM +PLEASE PROCEED ONLY IF YOU ARE 100% SURE THAT THE PROBLEM AND THE PROPOSED SOLUTION ARE COMPLETELY CLEAR. + +**THANK YOU FOR YOUR CAREFUL CONSIDERATION!** + +=============================================================================== + **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 [...] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a1803cbe7..f79ff26b9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,9 +34,10 @@ to determine the cause of your problem. If you have a general question, need hel ### GitHub Issues ### -- All issue **subscribers receive an email notification** from GitHub for each new comment, so these should only be used for sharing important information and not for personal discussions/questions -- We kindly ask you not to report bugs via GitHub Issues **unless you are certain to have found a fully reproducible and previously unreported issue** that must be fixed directly in [our source code](https://github.com/photoprism/photoprism) +We kindly ask you not to report bugs via GitHub Issues **unless you are certain to have found a fully reproducible and previously unreported issue** that must be fixed directly in [our source code](https://github.com/photoprism/photoprism). Thank you for your careful consideration! + - When reporting a problem, always include the software versions you are using and other information about your environment such as [browser, browser plugins](https://docs.photoprism.app/getting-started/troubleshooting/browsers/), operating system, [storage type](https://docs.photoprism.app/getting-started/troubleshooting/performance/#storage), [memory size](https://docs.photoprism.app/getting-started/troubleshooting/performance/#memory), and [processor](https://docs.photoprism.app/getting-started/troubleshooting/performance/#server-cpu) +- Note that all issue **subscribers receive an email notification** from GitHub for each new comment, so these should only be used for sharing important information and not for personal discussions/questions - [Contact us](https://photoprism.app/contact) or [a community member](https://link.photoprism.app/discussions) if you need help, it could be a local configuration problem, or a misunderstanding in how the software works - This gives our team the opportunity to [improve the docs](https://docs.photoprism.app/getting-started/troubleshooting/) and provide best-in-class support to you, instead of handling unclear/duplicate bug reports or triggering a flood of notifications by responding to comments diff --git a/README.md b/README.md index 70a8017d2..11cf71d33 100644 --- a/README.md +++ b/README.md @@ -103,9 +103,10 @@ Think of "free software" as in "free speech," not as in "free beer". Thank You! ### GitHub Issues ### -- All issue **subscribers receive an email notification** from GitHub for each new comment, so these should only be used for sharing important information and not for personal discussions/questions -- We kindly ask you not to report bugs via GitHub Issues **unless you are certain to have found a fully reproducible and previously unreported issue** that must be fixed directly in the app +We kindly ask you not to report bugs via GitHub Issues **unless you are certain to have found a fully reproducible and previously unreported issue** that must be fixed directly in the app. Thank you for your careful consideration! + - When reporting a problem, always include the software versions you are using and other information about your environment such as [browser, browser plugins](https://docs.photoprism.app/getting-started/troubleshooting/browsers/), operating system, [storage type](https://docs.photoprism.app/getting-started/troubleshooting/performance/#storage), [memory size](https://docs.photoprism.app/getting-started/troubleshooting/performance/#memory), and [processor](https://docs.photoprism.app/getting-started/troubleshooting/performance/#server-cpu) +- Note that all issue **subscribers receive an email notification** from GitHub for each new comment, so these should only be used for sharing important information and not for personal discussions/questions - [Contact us](https://photoprism.app/contact) or [a community member](https://link.photoprism.app/discussions) if you need help, it could be a local configuration problem, or a misunderstanding in how the software works - This gives our team the opportunity to [improve the docs](https://docs.photoprism.app/getting-started/troubleshooting/) and provide best-in-class support to you, instead of handling unclear/duplicate bug reports or triggering a flood of notifications by responding to comments