mirror of
https://github.com/Xaymar/obs-StreamFX
synced 2024-12-28 18:41:14 +00:00
project: Improve templates and UX
This commit is contained in:
parent
6f742da524
commit
c18c5e457a
4 changed files with 27 additions and 55 deletions
16
.github/ISSUE_TEMPLATE/config.yml
vendored
16
.github/ISSUE_TEMPLATE/config.yml
vendored
|
@ -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!
|
||||
|
|
14
.github/ISSUE_TEMPLATE/feature.yml
vendored
14
.github/ISSUE_TEMPLATE/feature.yml
vendored
|
@ -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
|
||||
|
|
45
.github/ISSUE_TEMPLATE/issue.yml
vendored
45
.github/ISSUE_TEMPLATE/issue.yml
vendored
|
@ -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
|
||||
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."
|
||||
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."
|
||||
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: "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."
|
||||
|
|
7
.github/pull_request_template.md
vendored
7
.github/pull_request_template.md
vendored
|
@ -2,9 +2,8 @@
|
|||
<!-- Describe the PR in as much detail as possible. If possible include example images, videos and documents, and explain why it is necessary. If this is related to a discussion or issue, please also link them. -->
|
||||
|
||||
#### 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:
|
||||
<!-- Check all items that apply. Don't lie here, we'll know the moment we verify this. -->
|
||||
- [ ] This has been tested on the following platforms: <!-- REQUIRED (at least one) -->
|
||||
- [ ] 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. <!-- REQUIRED -->
|
||||
- [ ] I will maintain this for the forseeable future, and have added myself to `CODEOWNERS`. <!-- REQUIRED for content or feature additions -->
|
||||
|
|
Loading…
Reference in a new issue