From 7fbbd39bf555c05b498d8309265f2d465074fe32 Mon Sep 17 00:00:00 2001
From: Michael Fabian 'Xaymar' Dirks <info@xaymar.com>
Date: Fri, 17 Apr 2020 11:11:51 +0200
Subject: [PATCH] project: Improve templates for issues/features/help/prs

---
 .github/ISSUE_TEMPLATE/feature.md  | 22 ++++++++---------
 .github/ISSUE_TEMPLATE/feedback.md | 27 ---------------------
 .github/ISSUE_TEMPLATE/help.md     | 23 ++++++++++++++++++
 .github/ISSUE_TEMPLATE/issue.md    | 31 ++++++------------------
 .github/pull_request_template.md   | 39 ++++++------------------------
 5 files changed, 48 insertions(+), 94 deletions(-)
 delete mode 100644 .github/ISSUE_TEMPLATE/feedback.md
 create mode 100644 .github/ISSUE_TEMPLATE/help.md

diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md
index e35a5c39..28cbe8de 100644
--- a/.github/ISSUE_TEMPLATE/feature.md
+++ b/.github/ISSUE_TEMPLATE/feature.md
@@ -1,20 +1,18 @@
 ---
-name: Feature request
+name: Request a new Feature
 about: Want a new feature implemented?
 
 ---
 
-<!--- Please fill out the following template, which will help other contributors review your Issue. -->
-<!--- Make sure you’ve read the contribution guidelines -->
+<!-- Hi, thank you for taking the time to ask for help. -->
+<!-- Please make sure that you fill this out in it's entirety. -->
+<!-- Unfortunately I will have to close issues if it has not been filled out. -->
 
 ### Description
-<!-- Describe the feature (and behavior) in as much detail as possible (yes, that means write an essay if you have to) -->
-<!-- Include images of what you expect from the feature -->
+<!-- Please describe the feature in its entirety. -->
+<!-- If you have artwork, links or similar, please attach them. -->
 
-### Checklist:
-<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
-<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
-- [ ] I have read the contribution guidelines.
-- [ ] This feature is necessary and can't be done through other means.
-- [ ] This feature does not break existing functionality.
-- [ ] I am willing to hire/pay someone to implement this.
+### Checklist
+<!-- Please check any that apply. If you aren't sure, leave them unchecked. -->
+- [ ] I am willing to pay someone to implement this feature.
+- [ ] This feature absolutely can't be done with already existing features.
diff --git a/.github/ISSUE_TEMPLATE/feedback.md b/.github/ISSUE_TEMPLATE/feedback.md
deleted file mode 100644
index 5a43994c..00000000
--- a/.github/ISSUE_TEMPLATE/feedback.md
+++ /dev/null
@@ -1,27 +0,0 @@
----
-name: Question/Feedback
-about: Submit a question or some feedback! (Not for bugs, issues or crashes!)
-
----
-
-<!--- Please fill out the following template, which will help other contributors review your Issue. -->
-<!--- Make sure you’ve read the contribution guidelines -->
-
-### Description
-<!-- Describe the feature (and behavior) in as much detail as possible (yes, that means write an essay if you have to) -->
-<!-- Include images of what you expect from the feature -->
-
-### System Information
-<!-- Include as much information about the system you're using as possible. -->
-- Software Version: [e. g. 1.0.0, 1.2.1, ... - NEVER LATEST]
-- Operating System: [e. g. Windows, Debian, Ubuntu, RedHat, FreeBSD, ...]
-- Kernel Version: [e. g. 1903/1809 (Windows), 4.12 (Linux), ...]
-- CPU: [e. g. Intel i7, AMD Zen2, Qualcomm, ...]
-- GPU: [e. g. Nvidia RTX 2xxx Series, AMD Radeone 5xxx Series, ...]
-- RAM: [e. g. 16GB, 32GB, 64GB, ...]
-
-### Checklist:
-<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
-<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
-- [ ] I have read the contribution guidelines.
-- [ ] This is not a bug, crash or generic issue.
diff --git a/.github/ISSUE_TEMPLATE/help.md b/.github/ISSUE_TEMPLATE/help.md
new file mode 100644
index 00000000..3b22a0ad
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/help.md
@@ -0,0 +1,23 @@
+---
+name: Request Help and Support
+about: Stuck using something? Why not ask for help?
+
+---
+
+<!-- Hi, thank you for taking the time to ask for help. -->
+<!-- Please make sure that you fill this out in it's entirety. -->
+<!-- Unfortunately I will have to close issues if it has not been filled out. -->
+
+### Description
+<!-- Please describe the problem in its entirety. -->
+<!-- If you have screenshots of the broken behavior, please attach them. -->
+<!-- Additionally, if you have log files, please ATTACH them. Do not paste them into this -->
+
+### System Information
+<!-- Either fill out the following or attach a DxDiag file. -->
+- Software Version: [e. g. 1.0.0, 1.2.1, ... - NEVER LATEST]
+- Operating System: [e. g. Windows, Debian, Ubuntu, RedHat, FreeBSD, ...]
+- Kernel Version: [e. g. 1903/1809 (Windows), 4.12 (Linux), ...]
+- CPU: [e. g. Intel i7, AMD Zen2, Qualcomm, ...]
+- GPU: [e. g. Nvidia RTX 2xxx Series, AMD Radeone 5xxx Series, ...]
+- RAM: [e. g. 16GB, 32GB, 64GB, ...]
diff --git a/.github/ISSUE_TEMPLATE/issue.md b/.github/ISSUE_TEMPLATE/issue.md
index 8205642a..0426e3d7 100644
--- a/.github/ISSUE_TEMPLATE/issue.md
+++ b/.github/ISSUE_TEMPLATE/issue.md
@@ -1,38 +1,23 @@
 ---
-name: Issue/Bug report
+name: Report a Bug, Crash or Freeze
 about: Encountered a problem, a bug or a crash?
 
 ---
 
-<!--- Please fill out the following template, which will help other contributors review your Issue. -->
-<!--- Make sure you’ve read the contribution guidelines -->
+<!-- Hi, thank you for taking the time to report a bug/crash/freeze. -->
+<!-- Please make sure that you fill this out in it's entirety. -->
+<!-- Unfortunately I will have to close issues if it has not been filled out. -->
 
 ### Description
-<!-- Describe the bug (and behavior) in as much detail as necessary -->
-<!-- Include screenshots and attach (crash) logs if possible -->
-
-### Expected Behavior
-<!-- What is the expected behavior in this case? -->
-
-### Reproduction Steps
-<!-- Describe the steps required to get this to happen from a cleanly installed obs-studio -->
-<!-- Leave out detail that is not relevant to  -->
-1. Open a portal to the Infinite Void
-2. Summon an ancient God
-3. Realize your mistake
+<!-- Please describe the bug/crash/freeze in its entirety, including how you made this happen. -->
+<!-- If you have screenshots of the broken behavior, please attach them. -->
+<!-- Additionally, if you have log files, please ATTACH them. Do not paste them into this -->
 
 ### System Information
-<!-- Include as much information about the system you're using as possible. -->
+<!-- Either fill out the following or attach a DxDiag file. -->
 - Software Version: [e. g. 1.0.0, 1.2.1, ... - NEVER LATEST]
 - Operating System: [e. g. Windows, Debian, Ubuntu, RedHat, FreeBSD, ...]
 - Kernel Version: [e. g. 1903/1809 (Windows), 4.12 (Linux), ...]
 - CPU: [e. g. Intel i7, AMD Zen2, Qualcomm, ...]
 - GPU: [e. g. Nvidia RTX 2xxx Series, AMD Radeone 5xxx Series, ...]
 - RAM: [e. g. 16GB, 32GB, 64GB, ...]
-
-### Checklist:
-<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
-<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
-- [ ] I have read the contribution guidelines.
-- [ ] I can reproduce the issue with the exact reproduction steps I have provided.
-- [ ] The issue appears on all of my systems that can run this software.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 383706e6..cbff0690 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,35 +1,10 @@
-<!--- Please fill out the following template, which will help other contributors review your Pull Request. -->
-
-<!--- Make sure you’ve read the contribution guidelines -->
+<!-- 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 your changes in detail. -->
-<!--- If this change includes UI elements, please include screenshots. -->
+<!-- Describe your changes in as much detail as possible. -->
+<!-- But please exclude your personal history from this. Only describe the changes -->
 
-### Motivation and Context
-<!--- Why is this change required? What problem does it solve? -->
-<!--- If it fixes an open Mantis issue, or implements feature request -->
-<!--- from the Ideas page, please link to the issue here. -->
-
-### How Has This Been Tested?
-<!--- Please describe in detail how you tested your changes. -->
-<!--- Include details of your testing environment (hardware, OS version, etc.),-->
-<!--- and the tests you ran, including how it may affect other areas of code. -->
-
-### Types of changes
-<!--- What types of changes does your PR introduce? Uncomment all that apply -->
-<!--- - Bug fix (non-breaking change which fixes an issue) -->
-<!--- - New feature (non-breaking change which adds functionality) -->
-<!--- - Performance enhancement (non-breaking change which improves efficiency) -->
-<!--- - Code cleanup (non-breaking change which makes code smaller or more readable) -->
-<!--- - Breaking change (fix or feature that would cause existing functionality to change) -->
-<!--- - Documentation (a change to documentation pages) -->
-
-### Checklist:
-<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
-<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
-- [ ] My code has been run through [clang-format](https://github.com/obsproject/obs-studio/blob/master/.clang-format).
-- [ ] I have read the [**contributing** document](https://github.com/obsproject/obs-studio/blob/master/CONTRIBUTING.rst).
-- [ ] My code is not on the master branch.
-- [ ] The code has been tested.
-- [ ] All commit messages are properly formatted and commits squashed where appropriate.
+### Related Issues
+<!-- - #0000 Name of Issue -->
+<!-- - #0001 Name of Issue -->