From 437769ac0b6006a1195c6d7ba6c30f21451c2f17 Mon Sep 17 00:00:00 2001
From: FranciscoPombal <FranciscoPombal@users.noreply.github.com>
Date: Wed, 19 Feb 2020 03:06:10 +0000
Subject: [PATCH] Revise GitHub templates

- Separate templates into bug report and feature request
- Add a checklist and guidance comments
- Add a PR template
- Add SUPPORT.md
---
 .github/ISSUE_TEMPLATE.md                     | 19 ----
 .github/ISSUE_TEMPLATE/bug_report.md          | 89 +++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml             | 20 +++++
 .github/ISSUE_TEMPLATE/feature_request.md     | 61 +++++++++++++
 .github/PULL_REQUEST_TEMPLATE/pull_request.md | 16 ++++
 .github/SUPPORT.md                            | 18 ++++
 6 files changed, 204 insertions(+), 19 deletions(-)
 delete mode 100644 .github/ISSUE_TEMPLATE.md
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request.md
 create mode 100644 .github/SUPPORT.md

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index a13ec97db..000000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,19 +0,0 @@
-**Please provide the following information**
-
-### qBittorrent version and Operating System
-(type here)
-
-### If on linux, libtorrent-rasterbar and Qt version
-(type here)
-
-### What is the problem
-(type here)
-
-### What is the expected behavior
-(type here)
-
-### Steps to reproduce
-(type here)
-
-### Extra info(if any)
-(type here)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 000000000..91fb448b8
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,89 @@
+---
+name: Bug Report
+about: Report a problem with qBittorrent to help us resolve it.
+title: ''
+labels: ''
+assignees: ''
+---
+
+# Bug report
+
+<!--
+###############################################################################
+  WARNING!
+  IGNORING THE INSTRUCTIONS IN THIS TEMPLATE WILL RESULT IN THE ISSUE BEING
+  CLOSED AS INCOMPLETE/INVALID
+###############################################################################
+-->
+
+## Checklist
+
+<!--
+################################## IMPORTANT ##################################
+
+As you read and fulfill each of the following requirements below,
+put an "x" between the square brackets to mark each task as done, like so: [x]
+-->
+
+- [ ] I have read the **issue reporting section** in the [contributing guidelines](https://github.com/qbittorrent/qBittorrent/blob/master/CONTRIBUTING.md), so I know how to submit a good bug report with the required information
+- [ ] I have verified that the **issue is not fixed and is reproducible** in the **[latest version](https://www.qbittorrent.org/download.php)**
+- [ ] (optional but recommended) I have verified that the **issue is not fixed and is reproducible** in the **[latest CI build](https://github.com/qbittorrent/qBittorrent/actions/workflows/ci.yaml?query=branch%3Amaster+event%3Apush)**
+- [ ] I have **checked the [frequent/common issues list](https://github.com/qbittorrent/qBittorrent/projects/2)** and **searched** the issue tracker for similar bug reports (including closed ones) **to avoid posting a duplicate**
+- [ ] This report is **not a support request or question**, both of which are better suited for either the [discussions section](https://github.com/qbittorrent/qBittorrent/discussions), [forum](https://qbforums.shiki.hu/), or [subreddit](https://www.reddit.com/r/qBittorrent/). The [wiki](https://github.com/qbittorrent/qBittorrent/wiki) did not contain a suitable solution either
+- [ ] I have **pasted/attached the settings file and relevant log(s)** in the **Attachments** section at the bottom of the report. Mandatory: the settings file and at least the most recent log. See [this wiki page](https://github.com/qbittorrent/qBittorrent/wiki/Frequently-Asked-Questions#Where_does_qBittorrent_save_its_settings) if you're not sure where to find them.
+
+## Description
+
+<!--
+################################## IMPORTANT ##################################
+
+Delete each "(type here)" indicator and type your text in their place in the subsections below.
+You MUST fill in ALL subsections marked with "(type here)" with the appropriate information.
+
+Please make sure the description is worded well enough to be understood.
+Provide steps to reproduce the issue, any additional relevant information, suggested solution (if applicable) and as much context and examples as possible.
+For more information consult the Contributing Guidelines at https://github.com/qbittorrent/qBittorrent/blob/master/CONTRIBUTING.md.
+
+Do not forget about the mandatory attachments!
+
+Use the Preview tab before posting to make sure your report looks like it is formatted properly.
+You don't need to delete these comments, they won't show up in the final post.
+-->
+
+### qBittorrent info and operating system(s)
+
+<!--
+IMPORTANT:
+if you did not get the qBittorrent installer from the links in the official website
+or if you did not install it from the PPA, please mention that after the version
+-->
+
+- qBittorrent version: (type here)
+- Operating system(s) where the issue occurs: (type here)
+
+### If on Linux, `libtorrent-rasterbar` and `Qt` versions
+
+- Qt: (type here)
+- libtorrent-rasterbar: (type here)
+
+### What is the problem
+
+(type here)
+
+### Detailed steps to reproduce the problem
+
+1. (type here)
+2. (type here)
+3. (etc.)
+
+### What is the expected behavior
+
+(type here)
+
+### Extra info (if any)
+
+(type here)
+
+## Attachments
+
+<!-- paste file contents here (or attach the files if they are big), do NOT link to external sites -->
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..00a736b56
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,20 @@
+blank_issues_enabled: false
+contact_links:
+  -
+    about: "Consult the wiki first (especially the FAQ), it might already contain the information you are looking for"
+    name: Wiki
+    url: "https://github.com/qbittorrent/qBittorrent/wiki/"
+
+  -
+    about: "Please ask questions related to usage/setup/support/non-issue development discussion in the Discussions section"
+    name: Question
+    url: "https://github.com/qbittorrent/qBittorrent/discussions"
+
+  -
+    about: "Alternatively, ask on the official forum"
+    name: Question
+    url: "http://forum.qbittorrent.org/"
+  -
+    about: "Alternatively, use the subreddit"
+    name: Question
+    url: "https://www.reddit.com/r/qBittorrent/"
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 000000000..0c452b583
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,61 @@
+---
+name: Feature Request
+about: Suggest a new feature or enhancement for qBittorrent.
+title: ''
+labels: 'Feature request'
+assignees: ''
+---
+
+# Feature request
+
+<!--
+###############################################################################
+  WARNING!
+  IGNORING THE INSTRUCTIONS IN THIS TEMPLATE WILL RESULT IN THE ISSUE BEING
+  CLOSED AS INCOMPLETE/INVALID
+###############################################################################
+-->
+
+## Checklist
+
+<!--
+################################## IMPORTANT ##################################
+
+As you read and fulfill each of the following requirements below,
+put an "x" between the square brackets to mark each task as done, like so: [x]
+-->
+
+- [ ] I have read the **feature request section** in the [contributing guidelines](https://github.com/qbittorrent/qBittorrent/blob/master/CONTRIBUTING.md), so I know how to submit a good feature request with the required information
+- [ ] I have verified that the **feature** I am requesting is **not available** in the **[latest version](https://www.qbittorrent.org/download.php)**
+- [ ] (optional but recommended) I have verified that the **feature** I am requesting is **not available** in the **[latest CI build](https://github.com/qbittorrent/qBittorrent/actions/workflows/ci.yaml?query=branch%3Amaster+event%3Apush)**
+- [ ] I have **checked the [frequent/common issues list](https://github.com/qbittorrent/qBittorrent/projects/2)** and **searched** the issue tracker for similar feature requests (including closed ones) **to avoid posting a duplicate**
+- [ ] This request is **not a support request or question**, both of which are better suited for either the [discussions section](https://github.com/qbittorrent/qBittorrent/discussions), [forum](https://qbforums.shiki.hu/), or [subreddit](https://www.reddit.com/r/qBittorrent/). The [wiki](https://github.com/qbittorrent/qBittorrent/wiki) did not contain a suitable solution either
+
+## Description
+
+<!--
+################################## IMPORTANT ##################################
+
+Delete each "(type here)" indicator and type your text in their place in the subsections below.
+You MUST fill in ALL subsections marked with "(type here)" with the appropriate information.
+
+Please make sure the description is worded well enough to be understood.
+Provide a detailed description of the feature and as much context and examples as necessary.
+If the feature request has to do with visual elements and the GUI, images/screenshots are always helpful.
+For more information consult the Contributing Guidelines at https://github.com/qbittorrent/qBittorrent/blob/master/CONTRIBUTING.md.
+
+Use the Preview tab before posting to make sure your report looks like it is formatted properly.
+You don't need to delete these comments, they won't show up in the final post.
+-->
+
+### Suggestion
+
+(type here)
+
+### Use case
+
+(type here)
+
+### Extra info/examples/attachments
+
+<!-- optional -->
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request.md b/.github/PULL_REQUEST_TEMPLATE/pull_request.md
new file mode 100644
index 000000000..d15f75620
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/pull_request.md
@@ -0,0 +1,16 @@
+# Changes proposed in this pull request
+
+<!--
+IMPORTANT: an image is worth a thousand words.
+It is often a good idea to post screenshots showing the "before" and "after" your PR's changes,
+especially with changes related to the GUI, along with the textual description.
+Images makes it immediately clearer for others what your proposed changes are all about.
+-->
+
+(type here)
+
+<!--
+OPTIONAL: if this PR directly addresses an issue, make sure to include a "Closes #XXXXX" statement at the end.
+-->
+
+<!-- You don't need to delete these comments before posting, they won't show up in the post :) -->
diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md
new file mode 100644
index 000000000..788387cd8
--- /dev/null
+++ b/.github/SUPPORT.md
@@ -0,0 +1,18 @@
+# Support Resources
+
+The issue tracker is only for bug reports/feature requests related to the project itself.
+
+Please do not use the issue tracker for questions about general program usage,
+how BitTorrent (the protocol) works in general, etc.
+
+For such questions, use one of the following community support resources:
+
+* The [discussions section][discussions-url]
+
+* The official forum [official forum][forum-url]
+
+* The [qBittorrent subreddit][subreddit-url]
+
+[discussions-url]: https://github.com/qbittorrent/qBittorrent/discussions
+[forum-url]: http://forum.qbittorrent.org/
+[subreddit-url]: https://www.reddit.com/r/qBittorrent/