From 00671270f586555aa87282a0e28e3ebb3acf50a1 Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Mon, 10 Jan 2022 14:00:49 +0100 Subject: [PATCH] Docs: Update README.md, CONTRIBUTING.md, and bug issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 5 +++-- CONTRIBUTING.md | 14 +++++++++----- README.md | 2 +- 3 files changed, 13 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 4f84d18b2..123b05853 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -54,8 +54,9 @@ Your app version / build number can be found in *Settings* when you scroll to th - PhotoPrism Architecture & Build Number - Database Type & Version (MySQL or SQLite) -- Browser Types & Versions (Firefox, Chrome, Safari on iPhone,...) - Operating System Types & Versions (Linux, Windows, Android,...) +- Browser Types & Versions (Firefox, Chrome, Safari on iPhone,...) +- Browser Plugins (if any) **What device is the backend running on?** @@ -66,6 +67,6 @@ This is especially important if you are reporting a performance, timing, or inde - Storage Type (HDD, SSD, RAID, USB, Network Storage,...) - anything else that might be helpful -**Do you use a proxy, load balancer, firewall, or CDN?** +**Do you use a proxy, load balancer, firewall, VPN, or CDN?** If yes, please specify type and version. You can skip this if you are reporting a completely unrelated issue. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2d757c399..c7895586c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,13 +16,17 @@ Our [Code of Conduct](CODE_OF_CONDUCT.md) explains the "dos and don’ts." ## Reporting Bugs ## -Before reporting a bug, try to [determine the cause of your problem](https://docs.photoprism.app/getting-started/troubleshooting/). +Before reporting a bug, please use our [Troubleshooting Checklists](https://docs.photoprism.app/getting-started/troubleshooting/) +to determine the cause of your problem. If you are unsure, need technical support, or have other questions: -If you ARE UNSURE, need TECHNICAL SUPPORT, or have a GENERAL QUESTION: -PLEASE USE [GITHUB DISCUSSIONS](https://github.com/photoprism/photoprism/discussions) 🗯 +- you are welcome to ask in our [Community Chat](https://gitter.im/browseyourlife/community) +- and post your question in [GitHub Discussions](https://github.com/photoprism/photoprism/discussions) -When [reporting a problem](https://github.com/photoprism/photoprism/issues), always include the version you are using -and information about your environment such as browser, operating system, installed memory, and processor type. +In addition, [sponsors](https://docs.photoprism.app/funding/) receive direct [technical support](https://photoprism.app/contact) via email. + +When reporting a [clearly identified bug](https://github.com/photoprism/photoprism/issues), always include the +version you are using and information about your environment such as browser, operating system, installed memory, +and processor type (see [template](https://github.com/photoprism/photoprism/blob/develop/.github/ISSUE_TEMPLATE/bug_report.md)). ## Pull Requests ## diff --git a/README.md b/README.md index 1062d5a47..5e30c6789 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ Think of "free software" as in "free speech," not as in "free beer". Thank you! *When reporting a problem, always include the version you are using and information about your environment such as browser, operating system, installed memory, and -processor type.* +processor type (see [template](https://github.com/photoprism/photoprism/blob/develop/.github/ISSUE_TEMPLATE/bug_report.md)).* ## Roadmap ##