From 92c8d9799e8442a7bd7fcd7537c33176ffdd01a5 Mon Sep 17 00:00:00 2001 From: Michael Fabian 'Xaymar' Dirks Date: Mon, 28 Nov 2022 09:54:02 +0100 Subject: [PATCH] project: Improve templates and UX --- .github/ISSUE_TEMPLATE/config.yml | 16 +++++++---- .github/ISSUE_TEMPLATE/feature.yml | 14 +++------- .github/ISSUE_TEMPLATE/issue.yml | 43 +++++------------------------- .github/pull_request_template.md | 7 ++--- 4 files changed, 26 insertions(+), 54 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 28b02cc29b..880822f9b5 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,11 +1,17 @@ blank_issues_enabled: false contact_links: - - name: Got an idea or feedback for StreamFX? - url: https://github.com/Xaymar/obs-StreamFX/discussions/categories/ideas-feedback - about: We're always open to new ideas and constructive feedback, as long as they have been discussed before. - - name: Having trouble using StreamFX? + - name: Looking for Help & Support? (Discord-style) + about: Join the Discord to get help and support! (Provided by volunteers only) url: https://s.xaymar.com/streamfx-dc - about: Join the official Discord and head to support-hub to get all the support necessary. + - name: Looking for Help & Support? (Forum-style) + about: For more detailed support, create a discussion thread! + url: https://github.com/Xaymar/obs-StreamFX/discussions/categories/general + - name: Got a question about functionality? + about: Consider using the Q&A discussion board! + url: https://github.com/Xaymar/obs-StreamFX/discussions/categories/q-a + - name: Share feedback and ideas for features on the forum! + about: We're open to ideas and suggestions, as well as constructive feedback. + url: https://github.com/Xaymar/obs-StreamFX/discussions/categories/ideas-feedback - name: OBS Studio Support url: https://obsproject.com/help about: Unsure if your Issue fits the StreamFX plugin? Consider the OBS Studio Support instead! diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index 1c066c9334..70f208ef85 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -1,18 +1,12 @@ --- -name: "File an Improvement Request" -title: "Replace Me Or Have Your Request Closed" -description: "Requests without an accompanying discussion thread will be closed and locked." +name: "File an Feature or Improvement request" +title: "REPLACE ME" +description: "This form is for developers only. Abuse of this form will be met with a permanent interaction ban." labels: ["enhancement"] body: - type: input attributes: label: "Discussion Thread" - description: "Please paste the direct link to the discussion thread" - validations: - required: true -- type: textarea - attributes: - label: "Provide a summary of the Improvement" - description: "This should only include parts that were agreed upon." + description: "Please paste the direct link to the discussion thread discussing this feature or improvement." validations: required: true diff --git a/.github/ISSUE_TEMPLATE/issue.yml b/.github/ISSUE_TEMPLATE/issue.yml index 34b08f8ddc..1e300e1bc2 100644 --- a/.github/ISSUE_TEMPLATE/issue.yml +++ b/.github/ISSUE_TEMPLATE/issue.yml @@ -1,43 +1,15 @@ -name: "File an Issue Report" -title: "Replace Me Or Have Your Report Closed" -description: "Use this if you've encountered a Bug, Crash or Freeze with StreamFX." +--- +name: "File an Bug or Crash report" +title: "REPLACE ME" +description: "This form is for bug and crash reports only, primarily used by developers. Abuse of this form will lead to a permanent interaction ban." labels: ["bug"] body: -- type: dropdown - attributes: - label: "Operating System" - description: "What Operating System do you use for OBS Studio and StreamFX? Select 'Other' if your Operating System is not listed" - options: - - "Windows 10 1903 and higher" - - "MacOS 10.15 and higher" - - "Linux (like Debian/Ubuntu)" - - "Linux (like Arch Linux)" - - "Linux (like FreeBSD)" - - "(Other)" - validations: - required: true -- type: input - attributes: - label: "OBS Studio Version" - description: "Which OBS Studio version are you using to run StreamFX? Versions include all patches (the third element in 'A.B.C'), and release candidates for that version. Select 'Other' if you are using a custom build." - validations: - required: true -- type: input - attributes: - label: "StreamFX Version" - description: "On which StreamFX version did you first encounter this issue?" - validations: - required: true -- type: input +- type: textarea attributes: - label: "OBS Studio Log" - description: "Upload a normal log file that showcases the issue happening. If you encountered a crash, also fill out the next field." + label: "OBS Studio Logs" + description: "Paste the content or attach the log files from OBS Studio here. In the event of a crash, paste or attach both the crash log and the normal log file." validations: required: true -- type: textarea - attributes: - label: "OBS Studio Crash Log" - description: "If OBS Studio crashed (not froze) paste the crash log here, or upload it somewhere and paste the link here." - type: textarea attributes: label: "Current and Expected Behavior" @@ -53,4 +25,3 @@ body: - type: textarea attributes: label: "Any additional Information we need to know?" - description: "If you answered '(Other)' to any system relevant information, explain what you mean by that here." diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 78e7a44685..d38eb14494 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,9 +2,8 @@ #### Completion Checklist -- [ ] I have added myself to the Copyright and License headers and files. -- [ ] I will maintain this code in the future and have added myself to `CODEOWNERS`. -- I have tested this change on the following platforms: + +- [ ] This has been tested on the following platforms: - [ ] MacOS 10.15 - [ ] MacOS 11 - [ ] MacOS 12 @@ -12,3 +11,5 @@ - [ ] Ubuntu 22.04 - [ ] Windows 10 - [ ] Windows 11 +- [ ] The copyright headers and license files have been updated. +- [ ] I will maintain this for the forseeable future, and have added myself to `CODEOWNERS`.