project: Improve Issue and PR templates

This commit is contained in:
Michael Fabian 'Xaymar' Dirks 2022-07-31 02:37:09 +02:00
parent f66891f956
commit ee6cd9fb50
4 changed files with 34 additions and 121 deletions

View file

@ -1,8 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: StreamFX Community Support
- 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?
url: https://s.xaymar.com/streamfx-dc
about: Looking for StreamFX support? Then join our Discord!
about: Join the official Discord and head to support-hub to get all the support necessary.
- name: OBS Studio Support
url: https://obsproject.com/help
about: Unsure if your Issue fits the StreamFX plugin? Consider the OBS Studio Support instead!

View file

@ -1,28 +1,18 @@
---
name: "Suggest an Enhancment to a Feature or a new Feature"
name: "File an Improvement Request"
title: "Replace Me Or Have Your Request Closed"
description: "Is there something that StreamFX is lacking or you'd like to see in OBS Studio?"
labels: ["type:enhancement", "status:help-wanted"]
description: "Requests without an accompanying discussion thread will be closed and locked."
labels: ["enhancement"]
body:
- type: textarea
- type: input
attributes:
label: "Explain the Feature/Enhancement"
description: "Describe the feature or enhancement in as much detail as possible, leave nothing out. If you think images or example videos help describe the Feature/Enhancement, include them."
label: "Discussion Thread"
description: "Please paste the direct link to the discussion thread"
validations:
required: true
- type: textarea
attributes:
label: "What makes this feature/enhancement useful for StreamFX and its users?"
description: "Why should this feature/enhancement become part of the StreamFX plugin, instead of becoming or remaining a third-party plug-in? What benefits do other users of StreamFX get from this?"
label: "Provide a summary of the Improvement"
description: "This should only include parts that were agreed upon."
validations:
required: true
- type: checkboxes
attributes:
label: "Checklist"
description: "Check all that apply."
options:
- label: "I am offering a monetary bounty/reward for the implementation of this Feature/Enhancement."
- label: "There is no other way to currently do this in StreamFX or OBS Studio."
- type: textarea
attributes:
label: "Any additional Information we need to know?"

View file

@ -1,7 +1,7 @@
name: "Report a Bug/Crash/Freeze"
name: "File an Issue Report"
title: "Replace Me Or Have Your Report Closed"
description: "Encountered a problem, a bug or a crash?"
labels: ["type:bug", "status:help-wanted"]
description: "Use this if you've encountered a Bug, Crash or Freeze with StreamFX."
labels: ["bug"]
body:
- type: dropdown
attributes:
@ -16,91 +16,16 @@ body:
- "(Other)"
validations:
required: true
- type: dropdown
- type: input
attributes:
label: "OBS Studio Version?"
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."
options:
- "27.1"
- "27.0"
- "26.1"
- "26.0"
- "25.0"
- "(Other)"
validations:
required: true
- type: dropdown
- type: input
attributes:
label: "StreamFX Version"
description: "On which StreamFX version did you first encounter this issue?"
options:
- "0.12.0a1"
- "0.11.1"
- "0.11.1b1"
- "0.11.1a1"
- "0.11.0"
- "0.11.0c1"
- "0.11.0b3"
- "0.11.0b2"
- "0.11.0b1"
- "0.11.0a8"
- "0.11.0a7"
- "0.11.0a6"
- "0.11.0a5"
- "0.11.0a4"
- "0.11.0a3"
- "0.11.0a2"
- "0.11.0a1"
- "0.10.1"
- "0.10.0"
- "0.10.0b3"
- "0.10.0b2"
- "0.10.0b1"
- "0.10.0a2"
- "0.10.0a1"
- "0.10.0a0"
- "0.9.3"
- "0.9.2"
- "0.9.1"
- "0.9.0"
- "0.9.0a3"
- "0.9.0a2"
- "0.9.0a1"
- "0.8.3"
- "0.8.2"
- "0.8.1"
- "0.8.0"
- "0.8.0b3"
- "0.8.0b2"
- "0.8.0b2hf2"
- "0.8.0b2hf1"
- "0.8.0b1"
- "0.8.0a4"
- "0.8.0a3"
- "0.8.0a2"
- "0.8.0a1"
- "0.7.2"
- "0.7.1"
- "0.7.0"
- "0.6.3"
- "0.6.2"
- "0.6.1"
- "0.6.0"
- "0.5.2"
- "0.5.1"
- "0.5.0"
- "0.5.0preview3"
- "0.5.0preview2"
- "0.5.0preview1"
- "0.4.3"
- "0.4.3preview1"
- "0.4.2"
- "0.4.1"
- "0.4.0"
- "0.3.0"
- "0.2.0"
- "0.1.1"
- "0.1.0"
validations:
required: true
- type: input
@ -115,19 +40,13 @@ body:
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 Behavior"
description: "What actually happened when you used StreamFX?"
label: "Current and Expected Behavior"
description: "What actually happened when you used StreamFX? What did you expect to happen?"
validations:
required: true
- type: textarea
attributes:
label: "Expected Behavior"
description: "What did you expect to happen when using StreamFX?"
validations:
required: true
- type: textarea
attributes:
label: "Steps to Reproduce the Bug"
label: "Steps to Reproduce the Problem"
description: "What steps are required to consistently reproduce the bug/crash/freeze?"
validations:
required: true

View file

@ -1,13 +1,14 @@
### Explain the Pull Request
<!-- Describe the PR in as much detail as possible, leave nothing out. -->
<!-- If you think images or example videos help describe the PR, include them. -->
<!-- What makes this PR necessary for StreamFX and it's users? -->
<!-- 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. -->
### Related Issues
<!-- Is this PR related to another PR or Issue? List them here. -->
<!-- - #0000 Name of Issue -->
<!-- - #0001 Name of Issue -->
### Checklist
- [ ] I will become the maintainer for this part of code.
- [ ] I have tested this code on all supported Platforms.
#### 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:
- [ ] MacOS 10.15
- [ ] MacOS 11
- [ ] MacOS 12
- [ ] Ubuntu 20.04
- [ ] Ubuntu 22.04
- [ ] Windows 10
- [ ] Windows 11