From 6969079e9cf3592ee5813486819a1da466ebaa22 Mon Sep 17 00:00:00 2001 From: Michael Fabian 'Xaymar' Dirks Date: Tue, 15 Jun 2021 20:06:22 +0200 Subject: [PATCH] project: Improve issue and pr templates --- .github/ISSUE_TEMPLATE/feature.yml | 1 + .github/ISSUE_TEMPLATE/issue.yml | 2 +- .github/PULL_REQUEST_TEMPLATE/config.yml | 5 ++++ .github/PULL_REQUEST_TEMPLATE/feature.md | 24 +++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE/feature.yml | 29 +++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE/fix.md | 22 +++++++++++++++++ .github/PULL_REQUEST_TEMPLATE/fix.yml | 29 +++++++++++++++++++++++ .github/pull_request_template.md | 19 --------------- 8 files changed, 111 insertions(+), 20 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE/config.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE/feature.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/feature.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE/fix.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/fix.yml delete mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index 8c20c748..c3d17cc6 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -1,5 +1,6 @@ --- 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?" labels: ["type:enhancement", "status:help-wanted"] body: diff --git a/.github/ISSUE_TEMPLATE/issue.yml b/.github/ISSUE_TEMPLATE/issue.yml index 8b391e94..2ba70c90 100644 --- a/.github/ISSUE_TEMPLATE/issue.yml +++ b/.github/ISSUE_TEMPLATE/issue.yml @@ -1,5 +1,5 @@ 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?" labels: ["type:bug", "status:help-wanted"] body: diff --git a/.github/PULL_REQUEST_TEMPLATE/config.yml b/.github/PULL_REQUEST_TEMPLATE/config.yml new file mode 100644 index 00000000..338c7d4d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/config.yml @@ -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! diff --git a/.github/PULL_REQUEST_TEMPLATE/feature.md b/.github/PULL_REQUEST_TEMPLATE/feature.md new file mode 100644 index 00000000..27b7cf32 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/feature.md @@ -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 + + + +### Why is this useful? + + + +### 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 + + + diff --git a/.github/PULL_REQUEST_TEMPLATE/feature.yml b/.github/PULL_REQUEST_TEMPLATE/feature.yml new file mode 100644 index 00000000..35336022 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/feature.yml @@ -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?" diff --git a/.github/PULL_REQUEST_TEMPLATE/fix.md b/.github/PULL_REQUEST_TEMPLATE/fix.md new file mode 100644 index 00000000..a5b709bc --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/fix.md @@ -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 + + + +### Why is this necessary? + + +### Checklist +- [ ] I will become the maintainer for this part of code. +- [ ] I have tested this code on all supported Platforms. + +### Related Issues + + + diff --git a/.github/PULL_REQUEST_TEMPLATE/fix.yml b/.github/PULL_REQUEST_TEMPLATE/fix.yml new file mode 100644 index 00000000..81924cc9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/fix.yml @@ -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." diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index c0adab90..00000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,19 +0,0 @@ - - - -### Description - - - -#### Old Behavior - - - -#### New Behavior - - - -### Related Issues - - -