From 8e9b3ef7bbe6931ff33aafca190eabbbc5f8ec16 Mon Sep 17 00:00:00 2001 From: tt2468 <tt2468@gmail.com> Date: Sun, 21 Nov 2021 01:38:20 -0800 Subject: [PATCH] ISSUE_TEMPLATE: Move to new standard In order to overwrite what the org uses, we must update our issue template to the new system. --- .github/ISSUE_TEMPLATE.md | 20 --- .github/ISSUE_TEMPLATE/bug_report.yaml | 129 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 + .github/ISSUE_TEMPLATE/feature_request.yaml | 42 +++++++ 4 files changed, 176 insertions(+), 20 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 16f26ba7..00000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,20 +0,0 @@ -##### Issue type -<!--- Uncomment one of the two options below. --> - -<!--- - Bug report --> -<!--- - Feature request --> - -##### Description -<!--- Describe the bug encountered or feature requested. --> - -##### Steps to reproduce and other useful info -<!--- If it's a bug, please describe the steps to reproduce it and PLEASE include an OBS log file. Otherwise, remove this section. --> - -##### Technical information -- **Operating System:** -- **OBS Studio version:** -- **obs-websocket version:** - -##### Development Environment -<!--- If you're trying to compile obs-websocket, please describe your compiler type and version (e.g: GCC 4.7, VC2013, ...), and the CMake settings used. --> -<!--- Remove this section if it does not apply. --> diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..839c9545 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,129 @@ +name: Bug Report +description: Report a bug or crash +title: "Bug: " +labels: ["Issue: Bug - Unconfirmed"] +body: +- type: markdown + id: md_welcome + attributes: + value: This form is for reporting bugs for obs-websocket! +- type: dropdown + id: os_info + attributes: + label: Operating System Info + description: What Operating System are you running? + options: + - Windows 11 + - Windows 10 + - Windows 8.1 + - macOS 12.0 + - macOS 11.6 + - macOS 11.5 + - macOS 11.4 + - macOS 11.3 + - macOS 11.2 + - macOS 11.1 + - macOS 11.0 + - macOS 10.15 + - macOS 10.14 + - macOS 10.13 + - Ubuntu 21.04 + - Ubuntu 20.10 + - Ubuntu 20.04 + - Ubuntu 18.04 + - Other + validations: + required: true +- type: input + id: os_info_other + attributes: + label: Other OS + description: "If \"Other\" was selected above, what OS are you using?" + placeholder: "e.g., Arch Linux, FreeBSD" + validations: + required: false +- type: dropdown + id: obs_version + attributes: + label: OBS Studio Version + description: What version of OBS Studio are you using? + options: + - 27.1.3 + - 27.1.1 + - 27.1.0 + - 27.0.1 + - Git + - Other + validations: + required: true +- type: input + id: obs_version_other + attributes: + label: OBS Studio Version (Other) + description: "If \"Other\" was selected above, what version of OBS Studio are you using?" + validations: + required: false +- type: dropdown + id: obs_websocket_version + attributes: + label: obs-websocket Version + description: What version of obs-websocket are you using? + options: + - 5.0.0-alpha2 + - 5.0.0-alpha1 + - 4.9.1 + - 4.9.0 + - Git + validations: + required: true +- type: input + id: obs_log_url + attributes: + label: OBS Studio Log URL + description: Please provide the obsproject.com URL (from Help menu > Log Files > Upload Current/Last Log File) to the OBS log file where this issue occurred. + validations: + required: true +- type: input + id: obs_crash_log_url + attributes: + label: OBS Studio Crash Log URL + description: If this is a crash report, please provide the obsproject.com URL to the OBS crash log file where this issue occurred. + validations: + required: false +- type: textarea + id: expected_behavior + attributes: + label: Expected Behavior + description: "What did you expect to happen?" + validations: + required: true +- type: textarea + id: current_behavior + attributes: + label: Current Behavior + description: "What actually happened?" + validations: + required: true +- type: textarea + id: steps_to_reproduce + attributes: + label: Steps to Reproduce + description: "How do you trigger this bug? Please walk us through it step by step." + placeholder: | + 1. + 2. + 3. + ... + value: | + 1. + 2. + 3. + ... + validations: + required: true +- type: textarea + id: additional_notes + attributes: + label: Anything else we should know? + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..48eea611 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Help/Support + url: https://discord.gg/UjfPmYdRPZ + about: Development-related help for obs-websocket diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000..6f84aad4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,42 @@ +name: Feature Request +description: Request for a new feature (request/event) to be added to obs-websocket +title: "Feature Request: " +labels: ["Issue: Feature Request"] +body: +- type: markdown + id: md_welcome + attributes: + value: This form is for requesting features for obs-websocket! +- type: dropdown + id: feature_request_type + attributes: + label: Feature Request Type + description: What kind of feature would you like to see added to obs-websocket? + options: + - RPC Request + - RPC Event + - Settings Dialog + - Other + validations: + required: true +- type: input + id: feature_request_type_other + attributes: + label: Feature Request Type (Other) + description: "If \"Other\" was selected above, what type of feature request do you have?" + validations: + required: false +- type: textarea + id: requested_feature + attributes: + label: Requested Feature + description: "What feature would you like to see added?" + validations: + required: true +- type: textarea + id: requested_feature_scenario + attributes: + label: Requested Feature Usage Scenario + description: "What is a use-case where this feature would be helpful?" + validations: + required: true