From fc1ba653cd47ef9cb4519e55478bacd374cc0ff4 Mon Sep 17 00:00:00 2001 From: DogmaDragon <103123951+DogmaDragon@users.noreply.github.com> Date: Wed, 24 Sep 2025 17:51:57 +0300 Subject: [PATCH] Refactor issue templates: replace markdown files with YAML configurations for bug reports, feature requests --- .github/ISSUE_TEMPLATE/bug_report.md | 40 ------------ .github/ISSUE_TEMPLATE/bug_report.yml | 64 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 ++++ ...scussion---request-for-commentary--rfc-.md | 24 ------- .github/ISSUE_TEMPLATE/feature_request.md | 20 ------ .github/ISSUE_TEMPLATE/feature_request.yml | 44 +++++++++++++ 6 files changed, 119 insertions(+), 84 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/discussion---request-for-commentary--rfc-.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index ea06d6d43..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[Bug Report] Short Form Subject (50 Chars or less)" -labels: bug report -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem please ensure that your screenshots are SFW or at least appropriately censored. - -**Stash Version: (from Settings -> About):** - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..0dc6d10a8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,64 @@ +name: Bug Report +description: Create a report to help us fix the bug +labels: ["bug report"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: description + attributes: + label: Describe the bug + description: Provide a clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Steps to reproduce + description: Detail the steps that would replicate this issue. + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behaviour + description: Provide clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + id: context + attributes: + label: Screenshots or additional context + description: Provide any additional context and SFW screenshots here to help us solve this issue. + validations: + required: false + - type: input + id: stashversion + attributes: + label: Stash version + description: This can be found in Settings > About. + placeholder: (e.g. v0.28.1) + validations: + required: true + - type: input + id: devicedetails + attributes: + label: Device details + description: | + If this is an issue that occurs when using the Stash interface, please provide details of the device/browser used which presents the reported issue. + placeholder: (e.g. Firefox 97 (64-bit) on Windows 11) + validations: + required: false + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output from Settings > Logs. This will be automatically formatted into code, so no need for backticks. + render: shell \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..028fdf8ac --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: Community forum + url: https://discourse.stashapp.cc + about: Start a discussion on the community forum. + - name: Community Discord + url: https://discord.gg/Y8MNsvQBvZ + about: Chat with the community on Discord. + - name: Documentation + url: https://docs.stashapp.cc + about: Check out documentation for help and information. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/discussion---request-for-commentary--rfc-.md b/.github/ISSUE_TEMPLATE/discussion---request-for-commentary--rfc-.md deleted file mode 100644 index b79564f83..000000000 --- a/.github/ISSUE_TEMPLATE/discussion---request-for-commentary--rfc-.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Discussion / Request for Commentary [RFC] -about: This is for issues that will be discussed and won't necessarily result directly - in commits or pull requests. -title: "[RFC] Short Form Title" -labels: help wanted -assignees: '' - ---- - - - -## Long Form - - -## Examples - - -## Reference Reading - diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index db5df9d8b..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "[Feature] Short Form Title (50 chars or less.)" -labels: feature request -assignees: '' - ---- - -**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 [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..f139433c5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,44 @@ +name: Feature Request +description: Request a new feature or idea to be added to Stash +labels: ["feature request"] +body: + - type: textarea + id: description + attributes: + label: Describe the feature you'd like + description: Provide a clear description of the feature you'd like implemented + validations: + required: true + - type: textarea + id: benefits + attributes: + label: Describe the benefits this would bring to existing users + description: | + Explain the measurable benefits this feature would achieve for existing users. + The benefits should be described in terms of outcomes for users, not specific implementations. + validations: + required: true + - type: textarea + id: already_possible + attributes: + label: Is there an existing way to achieve this goal? + description: | + Yes/No. If Yes, describe how your proposed feature differs from or improves upon the current method + validations: + required: true + - type: checkboxes + id: confirm-search + attributes: + label: Have you searched for an existing open/closed issue? + description: | + To help us keep these issues under control, please ensure you have first [searched our issue list](https://github.com/stashapp/stash/issues?q=is%3Aissue) for any existing issues that cover the core request or benefit of your proposal. + options: + - label: I have searched for existing issues and none cover the core request of my proposal + required: true + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. + validations: + required: false \ No newline at end of file