mirror of
https://github.com/Xaymar/obs-StreamFX
synced 2024-11-11 06:15:05 +00:00
project: Improve issue and pr templates
This commit is contained in:
parent
8eef6ddd85
commit
6969079e9c
8 changed files with 111 additions and 20 deletions
1
.github/ISSUE_TEMPLATE/feature.yml
vendored
1
.github/ISSUE_TEMPLATE/feature.yml
vendored
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
name: "Suggest an Enhancment to a Feature or a new Feature"
|
name: "Suggest an Enhancment to a Feature or a new Feature"
|
||||||
|
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?"
|
description: "Is there something that StreamFX is lacking or you'd like to see in OBS Studio?"
|
||||||
labels: ["type:enhancement", "status:help-wanted"]
|
labels: ["type:enhancement", "status:help-wanted"]
|
||||||
body:
|
body:
|
||||||
|
|
2
.github/ISSUE_TEMPLATE/issue.yml
vendored
2
.github/ISSUE_TEMPLATE/issue.yml
vendored
|
@ -1,5 +1,5 @@
|
||||||
name: "Report a Bug/Crash/Freeze"
|
name: "Report a Bug/Crash/Freeze"
|
||||||
title: "[BUG] (Replace this part including the brackets)"
|
title: "Replace Me Or Have Your Report Closed"
|
||||||
description: "Encountered a problem, a bug or a crash?"
|
description: "Encountered a problem, a bug or a crash?"
|
||||||
labels: ["type:bug", "status:help-wanted"]
|
labels: ["type:bug", "status:help-wanted"]
|
||||||
body:
|
body:
|
||||||
|
|
5
.github/PULL_REQUEST_TEMPLATE/config.yml
vendored
Normal file
5
.github/PULL_REQUEST_TEMPLATE/config.yml
vendored
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: StreamFX Community Support
|
||||||
|
url: https://s.xaymar.com/streamfx-dc
|
||||||
|
about: Looking for StreamFX support? Then join our Discord!
|
24
.github/PULL_REQUEST_TEMPLATE/feature.md
vendored
Normal file
24
.github/PULL_REQUEST_TEMPLATE/feature.md
vendored
Normal file
|
@ -0,0 +1,24 @@
|
||||||
|
---
|
||||||
|
name: "Submit a Feature/Enhancement"
|
||||||
|
about: "Implemented a new feature or enhancement and want it to be shipped with StreamFX?"
|
||||||
|
title: "Replace Me Or Have Your Pull Request Closed"
|
||||||
|
labels: "type:enhancement" "status:help-wanted" "status:testing-required"
|
||||||
|
---
|
||||||
|
|
||||||
|
### Explain the Feature/Enhancement
|
||||||
|
<!-- 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. -->
|
||||||
|
|
||||||
|
### Why is this useful?
|
||||||
|
<!-- Why should this feature/enhancement become part of the StreamFX plugin? -->
|
||||||
|
<!-- What benefits do other users of StreamFX get from this? -->
|
||||||
|
|
||||||
|
### Checklist
|
||||||
|
- [ ] I will become the maintainer for this part of code.
|
||||||
|
- [ ] I have tested this code on all supported Platforms.
|
||||||
|
- [ ] There is no other way to currently do this in StreamFX or OBS Studio.
|
||||||
|
|
||||||
|
### Related Issues
|
||||||
|
<!-- Is this PR related to another PR or Issue? List them here. -->
|
||||||
|
<!-- - #0000 Name of Issue -->
|
||||||
|
<!-- - #0001 Name of Issue -->
|
29
.github/PULL_REQUEST_TEMPLATE/feature.yml
vendored
Normal file
29
.github/PULL_REQUEST_TEMPLATE/feature.yml
vendored
Normal file
|
@ -0,0 +1,29 @@
|
||||||
|
---
|
||||||
|
name: "Submit a Feature/Enhancement"
|
||||||
|
description: "Implemented a new feature or enhancement and want it to be shipped with StreamFX?"
|
||||||
|
title: "Replace Me Or Have Your Pull Request Closed"
|
||||||
|
labels: ["type:enhancement", "status:help-wanted", "status:testing-required"]
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
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."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: "Why is this useful?"
|
||||||
|
description: "Why should this feature/enhancement become part of the StreamFX plugin? What benefits do other users of StreamFX get from this?"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: "Checklist"
|
||||||
|
description: "Check all that apply."
|
||||||
|
options:
|
||||||
|
- label: "I will become the maintainer for this part of code."
|
||||||
|
- label: "I have tested this code on all supported Platforms."
|
||||||
|
- 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?"
|
22
.github/PULL_REQUEST_TEMPLATE/fix.md
vendored
Normal file
22
.github/PULL_REQUEST_TEMPLATE/fix.md
vendored
Normal file
|
@ -0,0 +1,22 @@
|
||||||
|
---
|
||||||
|
name: "Submit a Fix"
|
||||||
|
about: "Fixed a problem with StreamFX?"
|
||||||
|
title: "Replace Me Or Have Your Pull Request Closed"
|
||||||
|
labels: "type:fix" "status:help-wanted" "status:testing-required"
|
||||||
|
---
|
||||||
|
|
||||||
|
### Explain the Fix
|
||||||
|
<!-- Describe the fix in as much detail as possible, leave nothing out. -->
|
||||||
|
<!-- If you think images or example videos help describe the Fix, include them. -->
|
||||||
|
|
||||||
|
### Why is this necessary?
|
||||||
|
<!-- What makes this Fix necessary for StreamFX and it's users? -->
|
||||||
|
|
||||||
|
### Checklist
|
||||||
|
- [ ] I will become the maintainer for this part of code.
|
||||||
|
- [ ] I have tested this code on all supported Platforms.
|
||||||
|
|
||||||
|
### Related Issues
|
||||||
|
<!-- Is this PR related to another PR or Issue? List them here. -->
|
||||||
|
<!-- - #0000 Name of Issue -->
|
||||||
|
<!-- - #0001 Name of Issue -->
|
29
.github/PULL_REQUEST_TEMPLATE/fix.yml
vendored
Normal file
29
.github/PULL_REQUEST_TEMPLATE/fix.yml
vendored
Normal file
|
@ -0,0 +1,29 @@
|
||||||
|
---
|
||||||
|
name: "Create a Pull Request for a Fix"
|
||||||
|
description: "Fixed a problem with StreamFX?"
|
||||||
|
title: "Replace Me Or Have Your Pull Request Closed"
|
||||||
|
labels: ["type:fix", "status:help-wanted", "status:testing-required"]
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: "Explain the Fix"
|
||||||
|
description: "Describe what the fix changes in as much detail as possible, leave nothing out. If you think images or example videos help describe the Fix, include them."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: "Why is this necessary?"
|
||||||
|
description: "What makes this Fix necessary for StreamFX and it's users?"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: "Checklist"
|
||||||
|
description: "Check all that apply."
|
||||||
|
options:
|
||||||
|
- label: "I will become the maintainer for this part of code."
|
||||||
|
- label: "I have tested this code on all supported Platforms."
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: "Any additional Information we need to know?"
|
||||||
|
description: "Related issues, etc."
|
19
.github/pull_request_template.md
vendored
19
.github/pull_request_template.md
vendored
|
@ -1,19 +0,0 @@
|
||||||
<!-- Hi, thank you for taking the time to submit a pull request. -->
|
|
||||||
<!-- Please make sure that you fill this out in it's entirety. -->
|
|
||||||
|
|
||||||
### Description
|
|
||||||
<!-- Describe what the PR does in detail, and why this is necessary. -->
|
|
||||||
<!-- Please do not include any personal history, or personal reasons - keep things objective, not subjective. -->
|
|
||||||
|
|
||||||
#### Old Behavior
|
|
||||||
<!-- Describe the old behavior -->
|
|
||||||
<!-- Attach videos or screenshots of the old behavior -->
|
|
||||||
|
|
||||||
#### New Behavior
|
|
||||||
<!-- Describe the new behavior -->
|
|
||||||
<!-- Attach videos or screenshots of the new behavior -->
|
|
||||||
|
|
||||||
### Related Issues
|
|
||||||
<!-- Is this PR related to another PR or Issue? List them here. -->
|
|
||||||
<!-- - #0000 Name of Issue -->
|
|
||||||
<!-- - #0001 Name of Issue -->
|
|
Loading…
Reference in a new issue