From db09c20a53d389781a49deb133f377cf41bd1e61 Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Mon, 10 Jan 2022 09:47:47 +0100 Subject: [PATCH] Docs: Add link to troubleshooting checklists Before reporting a bug, try to determine the cause of your problem... --- CODE_OF_CONDUCT.md | 2 +- CONTRIBUTING.md | 57 +++++++++++++++++----------------------------- 2 files changed, 22 insertions(+), 37 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index e1db6d41e..e25d8cc74 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -15,7 +15,7 @@ The following non-exhaustive list provides specific guidelines and examples: - Be respectful, be responsible, be kind - Avoid asking for deadlines - Don't feel entitled to free support, advice, or features if you are not a [contributor](https://docs.photoprism.app/developer-guide/), [sponsor](https://docs.photoprism.app/funding/), or paying customer -- Before reporting a bug, try to determine the cause of your problem +- Before reporting a bug, try to [determine the cause of your problem](https://docs.photoprism.app/getting-started/troubleshooting/) - If you have a [general question](https://github.com/photoprism/photoprism/discussions) or need [technical support](https://docs.photoprism.app/user-guide/#getting-support), don't use GitHub Issues - If you are having a bad day and want to offend someone, please go somewhere else diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 23f611d58..1d9bed602 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,66 +7,51 @@ are more focused on immediate results. We welcome contributions of any kind, including bug reports, testing, writing documentation, tutorials, blog posts, and pull requests. -## Code of Conduct ## - -Our [code of conduct](CODE_OF_CONDUCT.md) explains the "dos and don'ts." - ## Questions? ## -Follow us on [Twitter](https://twitter.com/photoprism_app) to receive regular project updates, -get in contact with other contributors and discuss your ideas. +Follow us on [Twitter](https://twitter.com/photoprism_app) or join our [Community Chat](https://gitter.im/browseyourlife/community) +to get regular updates, connect with other contributors, and discuss your ideas. -Of all the tools we tested, it works best to get and give continuous feedback. -Especially polls are amazing for product development. - -## Roadmap ## - -Our vision is to provide the most user-friendly solution for browsing, organizing, and sharing your photo collection. -The [roadmap](https://github.com/photoprism/photoprism/projects/5) shows what tasks are in progress, -what needs testing, and which feature requests are going to be implemented next. - -Please give ideas you like a thumbs-up ๐Ÿ‘ , so that we know what is most popular. -Ideas backed by one or more eligible [sponsors](SPONSORS.md) will be prioritized as well. - -You are welcome to add specific feature requests directly to our [GitHub issue tracker](https://github.com/photoprism/photoprism/issues) -if no similar [idea](https://github.com/photoprism/photoprism/labels/idea) -or [todo](https://github.com/photoprism/photoprism/labels/todo) already exists. -Please don't use the issue tracker to ask general questions. +Our [Code of Conduct](CODE_OF_CONDUCT.md) explains the "dos and donโ€™ts." ## Reporting Bugs ## -Please use the [GitHub issue tracker](https://github.com/photoprism/photoprism/issues) to report clearly identified bugs and impediments to us. -If you're not sure, start by asking in our [community chat](https://gitter.im/browseyourlife/community) or [contact us via email](mailto:help@photoprism.app). -When reporting an issue, please provide the version in use and information about your environment like browser, operating system, installed memory, and processor type. +Before reporting a bug, try to [determine the cause of your problem](https://docs.photoprism.app/getting-started/troubleshooting/). + +If you ARE UNSURE, need TECHNICAL SUPPORT, or have a GENERAL QUESTION: +PLEASE USE [GITHUB DISCUSSIONS](https://github.com/photoprism/photoprism/discussions)! THANK YOU ๐Ÿ’ + +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. ## Pull Requests ## -The [Developer Guide](https://docs.photoprism.app/developer-guide/) contains all information +The [Developer Guide](https://docs.photoprism.app/developer-guide/) contains all information necessary to get you started. Issues labeled [help wanted](https://github.com/photoprism/photoprism/labels/help%20wanted) / [easy](https://github.com/photoprism/photoprism/labels/easy) can be good (first) contributions. -Because we want to create the best possible product for our users, -we have a set of [guidelines](https://docs.photoprism.app/developer-guide/pull-requests) +Because we want to create the best possible product for our users, +we have a [set of guidelines](https://docs.photoprism.app/developer-guide/pull-requests) to ensure that all source code submissions are acceptable. -They include step-by-step instructions for submitting new features, +They include step-by-step instructions for submitting new features, bug fixes, and documentation improvements. -**Reviewing, testing and finally merging pull requests requires significant resources +**Reviewing, testing and finally merging pull requests requires significant resources on our side. If it's not just a small fix, it can take several months.** ## Can't code? ## -No worries, you may also contribute by... +No worries, you can also contribute by... -* doing [research](https://github.com/photoprism/photoprism/issues?q=is%3Aopen+is%3Aissue+label%3Aresearch) or improving our [docs](https://github.com/photoprism/photoprism/issues?q=is%3Aopen+is%3Aissue+label%3Adocs) -* recommending PhotoPrism to your friends -* voting for us on pages like: +* Doing [research](https://github.com/photoprism/photoprism/issues?q=is%3Aopen+is%3Aissue+label%3Aresearch) or improving our [docs](https://github.com/photoprism/photoprism/issues?q=is%3Aopen+is%3Aissue+label%3Adocs) +* Recommending PhotoPrism to your friends +* Voting for us on pages like: * https://alternativeto.net/software/photoprism/about/ * https://www.saashub.com/google-photos-alternatives -* publishing tutorials, blog posts, or podcasts +* Publishing tutorials, blog posts, or podcasts -Thank you very much! <3 +Thank you! <3