From f9bc7fca97d423f412934dc792e27093cdf36bb2 Mon Sep 17 00:00:00 2001 From: David Maisonave <47364845+David-Maisonave@users.noreply.github.com> Date: Sat, 10 Aug 2024 13:05:15 -0400 Subject: [PATCH] Added new issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 40 --------- .github/ISSUE_TEMPLATE/bug_report.yml | 77 +++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report_plugin.yml | 84 +++++++++++++++++++ ...scussion---request-for-commentary--rfc-.md | 24 ------ .github/ISSUE_TEMPLATE/discussion.yml | 42 ++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ----- .github/ISSUE_TEMPLATE/feature_request.yml | 35 ++++++++ .github/ISSUE_TEMPLATE/help.yml | 37 ++++++++ 8 files changed, 275 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/bug_report_plugin.yml delete mode 100644 .github/ISSUE_TEMPLATE/discussion---request-for-commentary--rfc-.md create mode 100644 .github/ISSUE_TEMPLATE/discussion.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/help.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index ea06d6d4329..00000000000 --- 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 00000000000..061780ac2e6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,77 @@ +name: 🐞 Bug +description: Create a bug report +title: "🐞[Bug] Your_Short_title" +labels: [Bug] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this bug report! + Fields marked with an asterisk (*) are required, and remaining fields are optional, but we encourage their usage. + Steps to reproduce the behavior: + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + - type: textarea + id: steps + attributes: + label: Please enter steps to reproduce the behavior. + validations: + required: true + - type: input + id: stash_ver + attributes: + label: Stash Version (from Settings -> About) + placeholder: e.g. v0.26.2 + validations: + required: true + - type: input + id: os + attributes: + label: What Operating System (OS)? + placeholder: e.g. Windows, MacOS, Linux, iOS8.1 (mobile OS) + validations: + required: true + - type: input + id: device + attributes: + label: Phone or tablets + placeholder: e.g. iPhone6, Galaxy Tab A9+ + validations: + required: false + - type: input + id: browser + attributes: + label: What browser and version? + placeholder: e.g. Chrome Ver:127, Firefox Ver:129, Safari Ver:1.3.2, Any + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: What was the expected behavior? + validations: + required: false + - type: textarea + id: logging + attributes: + label: Logging + description: Enter Stash logging. + validations: + required: false + - type: textarea + id: snapshots + attributes: + label: Snapshot(s) + description: Optionally attach snapshot(s) which displays the bug. + validations: + required: false + - type: textarea + id: additional + attributes: + label: Additional context + description: Add any other context about the problem here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/bug_report_plugin.yml b/.github/ISSUE_TEMPLATE/bug_report_plugin.yml new file mode 100644 index 00000000000..5c03d45b117 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report_plugin.yml @@ -0,0 +1,84 @@ +name: 🪲 Plugin Bug +description: Create a plugin bug report +title: "🪲[EnterPluginNameHere] Your_Short_title" +labels: [Plugin_Bug] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this bug report! + Fields marked with an asterisk (*) are required, and remaining fields are optional, but we encourage their usage. + Steps to reproduce the behavior: + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + - type: textarea + id: steps + attributes: + label: Please enter steps to reproduce the behavior. + validations: + required: true + - type: input + id: stash_ver + attributes: + label: Stash Version (from Settings -> About) + placeholder: e.g. v0.26.2 + validations: + required: true + - type: input + id: os + attributes: + label: What Operating System (OS)? + placeholder: e.g. Windows, MacOS, Linux, iOS8.1 (mobile OS) + validations: + required: true + - type: input + id: device + attributes: + label: Phone or tablets + placeholder: e.g. iPhone6, Galaxy Tab A9+ + validations: + required: false + - type: input + id: browser + attributes: + label: What browser and version? + placeholder: e.g. Chrome Ver:127, Firefox Ver:129, Safari Ver:1.3.2, Any + validations: + required: true + - type: textarea + id: install + attributes: + label: The pip install for the plugin + description: pip install stashapp-tools --upgrade, pip install pyYAML + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: What was the expected behavior? + validations: + required: false + - type: textarea + id: logging + attributes: + label: Logging + description: Enter Stash logging and plugin logging file if applicable. + validations: + required: false + - type: textarea + id: snapshots + attributes: + label: Snapshot(s) + description: Optionally attach snapshot(s) which displays the bug. + validations: + required: false + - type: textarea + id: additional + attributes: + label: Additional context + description: Add any other context about the problem here. + validations: + required: false \ 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 b79564f83b6..00000000000 --- 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/discussion.yml b/.github/ISSUE_TEMPLATE/discussion.yml new file mode 100644 index 00000000000..177b35cdfea --- /dev/null +++ b/.github/ISSUE_TEMPLATE/discussion.yml @@ -0,0 +1,42 @@ +name: 🛗Discussion / Request for Commentary [RFC] +description: This is for issues that will be discussed and won't necessarily result directly in commits or pull requests. +title: "🛗[RFC]: Your_Short_title" +labels: [RFC] +body: + - type: markdown + attributes: + value: | + This is for issues that will be discussed and won't necessarily result directly in commits or pull requests. + Please ensure that you respect people's time and attention and understand that people are volunteering their time, so concision is ideal and considerate. + Fields marked with an asterisk (*) are required, and remaining fields are optional, but we encourage their usage. + - type: textarea + id: Title + attributes: + label: Optional title of the topic to discuss. + validations: + required: false + - type: textarea + id: Summary + attributes: + label: Describe the scope of your topic and your goals ideally within a single paragraph or TL. A summary that makes it easier for people to determine if they can contribute at a glance. + validations: + required: true + - type: textarea + id: Details + attributes: + label: Only required if summary and title doesn't cover everything. + validations: + required: false + - type: textarea + id: Examples + attributes: + label: If you can show a picture or video examples post them here. + validations: + required: false + - type: textarea + id: snapshots + attributes: + label: Snapshot(s) + description: Optionally attach additional snapshot(s) which helps describe the discussion. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index db5df9d8ba7..00000000000 --- 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 00000000000..9593dc4139a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,35 @@ +name: 💡️Feature Request +description: Suggest improvement for this project +title: "💡️[Enhancement]: Your_Short_title" +labels: [Enhancement] +body: + - type: markdown + attributes: + value: | + Please fill out the following fields with as much detail as possible: + Fields marked with an asterisk (*) are required, and remaining fields are optional, but we encourage their usage. + - type: textarea + id: problem + attributes: + label: If feature request is related to a problem, give a clear and concise description of what is the problem. Ex. I'm always frustrated when [...] + validations: + required: false + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like. A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered. A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + - type: textarea + id: Snapshots + attributes: + label: Snapshots / Images + description: Add any other context or screenshots about the feature request here, which can help explain the feature, and a description of what to look for in the image(s). + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/help.yml b/.github/ISSUE_TEMPLATE/help.yml new file mode 100644 index 00000000000..dae58e2e820 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/help.yml @@ -0,0 +1,37 @@ +name: ❓Help +description: Post your question +title: "❓[Help]: Your_Short_title" +labels: [Question] +body: + - type: markdown + attributes: + value: | + Please fill out the following fields with as much detail as possible, so that we can better answer your question. + Fields marked with an asterisk (*) are required, and remaining fields are optional, but we encourage their usage. + - type: textarea + id: question + attributes: + label: Please enter a clear and concise detailed question. + validations: + required: true + - type: input + id: os + attributes: + label: What Operating System (OS)? + placeholder: e.g. Windows, MacOS, Linux + validations: + required: false + - type: input + id: browser + attributes: + label: What browser and version? + placeholder: e.g. Chrome Ver:127, Firefox Ver:129, Safari Ver:1.3.2, Any + validations: + required: false + - type: textarea + id: snapshots + attributes: + label: Snapshot(s) + description: Optionally attach snapshot(s) which helps describe the question. + validations: + required: false