beenull/photoprism
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Docs: Update README.md, CONTRIBUTING.md, and bug issue template

Browse source
This commit is contained in:
Michael Mayer 2022-01-10 14:00:49 +01:00
parent 7e4bb36bb1
commit 00671270f5
3 changed files with 13 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.github/ISSUE_TEMPLATE/bug_report.md vendored
View file

@ -54,8 +54,9 @@ Your app version / build number can be found in *Settings* when you scroll to th
- PhotoPrism Architecture & Build Number - PhotoPrism Architecture & Build Number
- Database Type & Version (MySQL or SQLite) - Database Type & Version (MySQL or SQLite)
- Browser Types & Versions (Firefox, Chrome, Safari on iPhone,...)
- Operating System Types & Versions (Linux, Windows, Android,...) - 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?** **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,...) - Storage Type (HDD, SSD, RAID, USB, Network Storage,...)
- anything else that might be helpful - 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. If yes, please specify type and version. You can skip this if you are reporting a completely unrelated issue.

14
CONTRIBUTING.md
View file

@ -16,13 +16,17 @@ Our [Code of Conduct](CODE_OF_CONDUCT.md) explains the "dos and don’ts."
## Reporting Bugs ## ## 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: - you are welcome to ask in our [Community Chat](https://gitter.im/browseyourlife/community)
PLEASE USE [GITHUB DISCUSSIONS](https://github.com/photoprism/photoprism/discussions) 🗯 - 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 In addition, [sponsors](https://docs.photoprism.app/funding/) receive direct [technical support](https://photoprism.app/contact) via email.
and information about your environment such as browser, operating system, installed memory, and processor type.
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 ## ## Pull Requests ##

2
README.md
View file

@ -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 *When reporting a problem, always include the version you are using and information
about your environment such as browser, operating system, installed memory, and 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 ## ## Roadmap ##