diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..05f72936b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,95 @@ +name: Bug Report +description: Report a new and clearly identified bug that must be fixed directly in the application +title: "Category: Short Description (PLEASE CHANGE)" +labels: + - bug +assignees: [] +body: + - type: markdown + attributes: + value: | + Before filing a bug report, verify that it is not a technical support request or question: + - thoroughly review our Getting Started and User Guides: + https://docs.photoprism.app/ + - work through our troubleshooting checklists: + https://docs.photoprism.app/getting-started/troubleshooting/ + - do not report known issues or missing features as bugs: + https://docs.photoprism.app/known-issues/ + - type: checkboxes + id: prerequisites + attributes: + label: Before You Continue + description: Confirm that you reviewed the guidance above. + options: + - label: I confirm that this is a new bug report, not a support request, and that I followed the linked troubleshooting steps. + required: true + - type: textarea + id: documented-behavior + attributes: + label: What Is Not Working as Documented? + description: Be specific and include links to the relevant documentation when possible. + placeholder: Describe the incorrect behavior and link to the related documentation on https://docs.photoprism.app/. + validations: + required: true + - type: textarea + id: reproduction-steps + attributes: + label: How Can We Reproduce It? + description: Provide numbered steps so we can reproduce the behavior reliably. + placeholder: | + 1. Go to ... + 2. Click ... + 3. Scroll to ... + 4. Expected vs. actual result + render: markdown + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: What Behavior Do You Expect? + description: Share the correct outcome you expected to see. + validations: + required: true + - type: textarea + id: possible-cause + attributes: + label: What Could Be the Cause? + description: Summarize any investigation you have already completed and the potential root cause. + - type: textarea + id: supporting-material + attributes: + label: Logs, Sample Files, or Screenshots + description: Attach or link to files that help us reproduce the problem. Import and indexing issues require sample files and logs. + placeholder: Provide links to archives, logs, or screenshots. See https://www.photoprism.app/contact for secure sharing options. + - type: textarea + id: software-versions + attributes: + label: Which Software Versions Do You Use? + description: Include all relevant software versions so we can reproduce the environment. + placeholder: | + - PhotoPrism Architecture & Build Number (AMD64, ARM64, ARMv7, ...): + - Database Type & Version (MariaDB, MySQL, SQLite, ...): + - Operating System Types & Versions (Linux, Windows, Android, ...): + - Browser Types & Versions (Firefox, Chrome, Safari on iPhone, ...): + - Ad Blockers, Browser Plugins, or Firewall Software: + render: markdown + validations: + required: true + - type: textarea + id: installation-device + attributes: + label: On What Device Is PhotoPrism Installed? + description: Provide hardware details, especially for performance, import, or indexing issues. + placeholder: | + - Device / Processor Type (Raspberry Pi 4, Intel Core i7-3770, AMD Ryzen 7 3800X, ...): + - Physical Memory & Swap Space (GB): + - Storage Type (HDD, SSD, RAID, USB, Network Storage, ...): + - Additional Context: + render: markdown + - type: textarea + id: networking-setup + attributes: + label: Do You Use a Reverse Proxy, Firewall, VPN, or CDN? + description: Specify type and version if applicable; include NGINX configuration when relevant. + placeholder: Describe proxies, VPNs, CDNs, or firewall software involved. Include versions and configuration snippets when helpful. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..ef6758945 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,51 @@ +name: Feature Request +description: Suggest a new feature or enhancement +title: "Category: Short Description (PLEASE CHANGE)" +labels: + - idea +assignees: [] +body: + - type: markdown + attributes: + value: | + PLEASE ONLY PROCEED IF YOU ARE ABSOLUTELY SURE THAT THIS IS NOT A TECHNICAL SUPPORT INCIDENT AND/OR A PROBLEM WITH OTHER SOFTWARE YOU ARE USING. + Review our public roadmap and search for existing feature requests before submitting a new one: + - https://link.photoprism.app/roadmap + - https://github.com/photoprism/photoprism/issues + Learn more about support options at https://www.photoprism.app/kb/getting-support. + - type: checkboxes + id: request-prep + attributes: + label: Confirmation + description: Make sure you completed these steps before opening a new request. + options: + - label: I confirm that this request is not a support question and that I searched the roadmap and existing issues. + required: true + - type: textarea + id: problem-statement + attributes: + label: What Problem Does This Solve and Why Is It Valuable? + description: Explain the underlying problem and why solving it matters to many users. + placeholder: Describe the problem, why it is important, and who is affected. + validations: + required: true + - type: textarea + id: proposed-solution + attributes: + label: What Solution Would You Like? + description: Provide a clear and concise description of the feature or enhancement you propose. + placeholder: Outline the proposed solution or experience from the user's perspective. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: What Alternatives Have You Considered? + description: Describe other options you explored and why they are less suitable. + placeholder: Mention any alternative solutions, workarounds, or related features you evaluated. + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Share relevant context, references, or screenshots that illustrate the request. + placeholder: Add links, references, or screenshots that help explain the request. diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 000000000..418ff1800 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,28 @@ +name: Question +description: General questions or assistance requests should go to Discussions or community channels +title: "Category: Short Description (PLEASE CHANGE)" +labels: + - question +assignees: [] +body: + - type: markdown + attributes: + value: | + FOR GENERAL QUESTIONS, TECHNICAL SUPPORT, AND TO GET TO KNOW OTHER COMMUNITY MEMBERS, VISIT https://github.com/photoprism/photoprism/discussions. + OUR TROUBLESHOOTING CHECKLISTS HELP YOU QUICKLY DIAGNOSE AND FIX COMMON PROBLEMS: https://docs.photoprism.app/getting-started/troubleshooting/. + PLEASE DO NOT OPEN AN ISSUE FOR YOUR QUESTION, AND USE GITHUB DISCUSSIONS OR OUR COMMUNITY CHAT INSTEAD. THANK YOU VERY MUCH! + - type: checkboxes + id: question-confirmation + attributes: + label: Please Confirm + options: + - label: I understand that general questions should be posted in Discussions or community chat, and I still need to open an issue here. + required: true + - type: textarea + id: question-details + attributes: + label: Question Details + description: Provide the specific question and the context needed to answer it. + placeholder: Summarize your question, the context, and any resources you have already reviewed. + validations: + required: true